POST
/
v1
/
app
/
project
/
{projectId}
/
interaction
{
  "id": "<string>",
  "project_id": "<string>",
  "thread_id": "<string>",
  "state": "Processing",
  "user_input": {
    "role": "system",
    "content": [
      {
        "data": "<string>",
        "mime_type": "<string>",
        "filename": "<string>",
        "start_timestamp": "<string>",
        "stop_timestamp": "<string>",
        "_meta": {}
      }
    ],
    "_meta": {}
  },
  "assistant_output": {
    "id": "<string>",
    "created": 123,
    "model": "<string>",
    "stop_reason": "stop",
    "content": [
      {
        "data": "<string>",
        "mime_type": "<string>",
        "filename": "<string>",
        "start_timestamp": "<string>",
        "stop_timestamp": "<string>",
        "_meta": {}
      }
    ],
    "usage": {
      "input_tokens": 123,
      "output_tokens": 123
    },
    "errors": [
      {
        "type": "<string>",
        "message": "<string>"
      }
    ]
  },
  "artifact_ids": [
    "<string>"
  ],
  "all_artifacts": true,
  "created_at": "<string>",
  "created_by": {
    "id": "<string>",
    "org_id": "<string>",
    "account_id": "<string>",
    "profile_picture": "<string>",
    "name": "<string>",
    "email": "<string>",
    "job_position_name": "<string>",
    "job_position_description": "<string>",
    "state": "Active",
    "roles": [
      "AppGuest"
    ],
    "created_at": "<string>"
  },
  "pgpt": {
    "messages": [
      {
        "role": "system",
        "content": [
          {
            "data": "<string>",
            "mime_type": "<string>",
            "filename": "<string>",
            "start_timestamp": "<string>",
            "stop_timestamp": "<string>",
            "_meta": {}
          }
        ],
        "_meta": {}
      }
    ],
    "stream": true,
    "tools": [
      {
        "name": "<string>",
        "type": "<string>",
        "description": "<string>",
        "inputSchema": {
          "properties": {},
          "required": [
            "<string>"
          ],
          "type": "<string>"
        }
      }
    ],
    "tool_choice": {
      "type": "<string>",
      "name": "<string>",
      "disable_parallel_tool_use": true
    },
    "mcp_servers": [
      {
        "url": "<string>",
        "name": "<string>",
        "authorization_token": "<string>",
        "tool_configuration": {
          "enabled": true,
          "allowed_tools": [
            "<string>"
          ]
        },
        "type": "<string>"
      }
    ],
    "response_format": {
      "type": "text",
      "json_schema": {}
    },
    "system": {
      "use_default_prompt": true,
      "text": "<string>",
      "citations": {
        "enabled": true,
        "known_citations": [
          {
            "id": "<string>",
            "index": "<string>",
            "artifact_id": "<string>",
            "source_id": "<string>",
            "correlation_id": "<string>"
          }
        ]
      }
    },
    "thinking": {
      "enabled": true
    },
    "priority": 123,
    "seed": 123,
    "min_p": 123,
    "top_p": 123,
    "temperature": 123,
    "top_k": 123,
    "repetition_penalty": 123,
    "presence_penalty": 123,
    "frequency_penalty": 123,
    "max_tokens": 123,
    "correlation_id": "<string>",
    "tool_context": [
      {
        "content": "<string>",
        "content_type": "<string>",
        "doc_metadata": {
          "file_name": "<string>",
          "file_type": "<string>"
        },
        "start_timestamp": "<string>",
        "stop_timestamp": "<string>",
        "_meta": {}
      }
    ]
  }
}

Path Parameters

projectId
string
required

The ID of the project to create the interaction in

Body

application/json

The details of the interaction to create

thread_id
string
all_artifacts
boolean
artifact_ids
string[]
pgpt
object
agent
enum<string>
Available options:
Default,
ProjectDeepResearch

Response

201 - application/json

Created interaction details

id
string
required
project_id
string
required
state
enum<string>
required
Available options:
Processing,
Completed,
Error
user_input
object
required
created_at
string
required
thread_id
string
assistant_output
object
artifact_ids
string[]
all_artifacts
boolean
created_by
object
pgpt
object