Creates a conversation with the awork Agent or a custom agent. | awork API

{
  "id": "6cbb219e-839d-4d23-b273-3a78bbd842ae",
  "threadRunId": "8f934a03-8f8b-44ea-9137-3ca563bb75e8",
  "acceptedMessageId": "66fcbdc5-2ae6-43bd-b3ab-f18ccd24909a",
  "type": "custom-agent",
  "title": "Weekly client status report",
  "status": "accepted",
  "createdOn": "2026-08-29T08:00:00Z",
  "createdBy": "9ad63972-4396-4b0b-9e7d-40b852cdebf8",
  "updatedOn": "2026-08-29T08:05:00Z",
  "updatedBy": "9ad63972-4396-4b0b-9e7d-40b852cdebf8",
  "agentId": "4d22e163-2b4a-4d47-b51c-5b2217f84f57",
  "projectId": "c907b29e-f640-4639-910d-722623fd5b4a",
  "taskId": "d88ef8fa-e549-4ca6-96d8-83f5be9d37a2",
  "clientId": "61341e18-3e3f-4efb-b471-b781e64f69f7",
  "documentId": "5a442338-8da3-49e9-a702-b45d6f829d43"
}

Creates a conversation with the awork Agent or a custom agent and optionally submits the first message. Supply content or attachments to submit the first message and start processing. awork Agent threads can be created without a message. Custom Agent threads require text or an attachment. The response contains the thread and accepted first-message identifiers, not the agent’s reply. See GET /agents/threads/{threadId}/messages to retrieve replies. Each request creates a new thread. Retrying after a lost response can create another thread.

Required Permissions

Any authenticated user.

Creates a conversation with the awork Agent or a custom agent and optionally submits the first message. Supply content or attachments to submit the first message and start processing. awork Agent threads can be created without a message. Custom Agent threads require text or an attachment. The response contains the thread and accepted first-message identifiers, not the agent's reply. See [GET /agents/threads/{threadId}/messages](api:GET/agents/threads/{threadId}/messages) to retrieve replies. Each request creates a new thread. Retrying after a lost response can create another thread. <Check title="Required Permissions" icon="key">Any authenticated user.</Check>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

The thread creation payload.

typeenumRequired

Select personal-agent for the awork Agent, or custom-agent for a configured workspace agent.

contentstring or nullOptional

The message text. Required when no attachments are supplied.

attachmentslist of objects or nullOptional

Up to 20 distinct files attached to this message. Upload new files before submitting their identifiers.

modelProviderstring or nullOptional

The provider for a model override. Supply it together with modelName.

modelNamestring or nullOptional

The model to use for this message. It must be available in the workspace.

reasoningLevelstring or nullOptional

The reasoning level for this message. Supported values depend on the selected model.

toolAccessobjectOptional

Per-message agent tool access options.

connectorIdslist of strings or nullOptional

The connector selection for this message.

connectorConnectionslist of objects or nullOptional

Connection choices for custom-agent connectors. These do not change agent settings.

skillIdslist of strings or nullOptional

The skill selection for this message.

agentIdstringOptionalformat: "uuid"

The configured agent to run. Required for custom-agent threads; omit for ordinary personal-agent threads.

titlestring or nullOptional

The thread title.

projectIdstring or nullOptionalformat: "uuid"

The project context id.

taskIdstring or nullOptionalformat: "uuid"

The task context id.

clientIdstring or nullOptionalformat: "uuid"

The client context id.

documentIdstring or nullOptionalformat: "uuid"

The document context id.

Response

idstringOptionalformat: "uuid"

The thread id.

threadRunIdstring or nullOptionalformat: "uuid"

The current run id.

acceptedMessageIdstring or nullOptionalformat: "uuid"

The accepted first-message id, or null when the thread was created without a message.

typestring or nullOptional

The thread type.

titlestring or nullOptional

The thread title.

statusenumOptional

The creation result: ready without a first message, accepted with a first message, queued when the first message waits for a run, or failed to start.

createdOnstring or nullOptionalformat: "date-time"

The creation timestamp.

createdBystringOptionalformat: "uuid"

The id of the user who created the thread.

updatedOnstring or nullOptionalformat: "date-time"

The last update timestamp.

updatedBystringOptionalformat: "uuid"

The id of the user who last updated the thread.

agentIdstring or nullOptionalformat: "uuid"

The custom agent assigned to the thread.

projectIdstring or nullOptionalformat: "uuid"

The associated project id.

taskIdstring or nullOptionalformat: "uuid"

The associated task id.

clientIdstring or nullOptionalformat: "uuid"

The associated client id.

documentIdstring or nullOptionalformat: "uuid"

The associated document id.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

503

Service Unavailable Error