API docs by Redocly

Partite.ai Conversation API (1.0.0)

Download OpenAPI specification:

This is the API used to manage Conversations on a Partite.ai server.

Conversation

Operations related to initiating conversations on a mesh.

Create a new empty conversation.

Creates a new conversation, without specifying an initial request or assets. If neither the version_ordinal nor version_label query parameters are provided, the draft version of the mesh will be used.

Authorizations:
apikey
query Parameters
mesh_id
required
string

The ID of the Mesh for which to create a conversation

version_ordinal
integer

The version number of a mesh version for which to create the conversation

version_label
string

The version label of a mesh version for which to create the conversation

Responses

Response samples

Content type
application/json
{
  • "conversation_id": "string",
  • "intents": [
    ]
}

Get intents for creating a conversation.

Retrieves the list of intents defined on a particular mesh version for which a new conversation can be started.

Authorizations:
apikey
query Parameters
mesh_id
required
string

The ID of the Mesh for which to get intents

version_ordinal
integer

The version number of a mesh version for which to get intents

version_label
string

The version label of a mesh version for which to get intents

Responses

Response samples

Content type
application/json
{
  • "intents": [
    ]
}

Create a new conversation with an initial request.

Creates a new conversation, specifying an initial request and attachments to start the conversation. If neither the version_ordinal nor version_label query parameters are provided, the draft version of the mesh will be used.

Authorizations:
apikey
path Parameters
intent_name
required
string

The name of the Intent defined on the target mesh which will be used to start the conversation

query Parameters
mesh_id
required
string

The ID of the Mesh for which to create a conversation

version_ordinal
required
integer

The version number of a mesh version for which to create the conversation

version_label
string

The version label of a mesh version for which to create the conversation

Request Body schema:
required

Information about the initial message and any assets to include with the request to start the conversation.

property name*
additional property
any

Responses

Request samples

Content type
{ }

Response samples

Content type
application/json
{
  • "conversation_id": "string",
  • "request_id": "string"
}

Get intents associated with a conversation.

Retrieves the list of intents associated with a particular conversation.

Authorizations:
apikey
path Parameters
conversation_id
required
string

The ID of an existing conversation

Responses

Response samples

Content type
application/json
{
  • "intents": [
    ]
}

Requests

Operations related to managing requests within an existing conversation.

Adds a request to a conversation.

Adds a request specified in JSON to an existing conversation.

Authorizations:
apikey
path Parameters
conversation_id
required
string

The ID of an existing conversation

intent_name
required
string

The name of the Intent defined on the target mesh which will be used for this request

Request Body schema:
required

Information about the initial message and any assets to include with the request to start the conversation.

property name*
additional property
any

Responses

Request samples

Content type
{ }

Response samples

Content type
application/json
{
  • "conversation_id": "string",
  • "request_id": "string"
}

Cancels execution of a request.

Cancels execution of a previously submitted request. Processing will be stopped at the next checkpoint, and the request will have a cancellation event added to its output.

Authorizations:
apikey
path Parameters
conversation_id
required
string

The ID of an existing conversation

request_id
required
string

The ID of an existing request

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "parameter": "string"
}

Adds results of executing a task to a request.

Used to submit the results of a task event that previously appeared as an output on the request.

Authorizations:
apikey
path Parameters
conversation_id
required
string

The ID of an existing conversation

request_id
required
string

The ID of an existing request

task_id
required
string

The ID of the task to complete

Request Body schema: application/json
required

Information about the task results

any

The result of executing the task. The expected format of this value depends on the type of task being executed.

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
{
  • "error": "string",
  • "parameter": "string"
}

Gets the results of a request as an event stream.

Gets the results of a request, as a stream of events. This allows for real-time updates and progress tracking.

Authorizations:
apikey
path Parameters
conversation_id
required
string

The ID of an existing conversation

request_id
required
string

The ID of an existing request

header Parameters
Last-Event-ID
string

The ID of the last event received. If provided, the stream will start from the next event after this ID.

Responses

Response samples

Content type
Example
{
  • "id": "string",
  • "type": "task",
  • "data": {
    }
}

Gets the response of a request.

Gets the final response of a request. This will block until the request is complete.

Authorizations:
apikey
path Parameters
conversation_id
required
string

The ID of an existing conversation

request_id
required
string

The ID of an existing request

Responses

Response samples

Content type
application/json
{ }

Gets the current task for a request.

If the request is currently waiting for a task to be completed, this endpoint will return the details of the task. It will block until a task is available or the request completes.

Authorizations:
apikey
path Parameters
conversation_id
required
string

The ID of an existing conversation

request_id
required
string

The ID of an existing request

Responses

Response samples

Content type
application/json
{
  • "task_id": "string",
  • "data": {
    }
}

Assets

Operations related to managing assets within an existing conversation.

Adds assets to a conversation.

Adds assets to an existing conversation.

Authorizations:
apikey
path Parameters
conversation_id
required
string

The ID of an existing conversation

Request Body schema: multipart/form-data

Assets to add to the conversation.

attachments
required
Array of strings <binary> [ items <binary > ]

Multiple parts, each representing a file upload including a Content-Type header and a filename attribute in the Content-Disposition header for the part

Responses

Response samples

Content type
application/json
{
  • "attachments": [
    ]
}