Skip to main content
POST
/
job
/
{runchat_job_id}
curl --request POST \
  --url https://runchat.com/api/v1/job/{runchat_job_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "message": "Summarize today's incoming support tickets and post the digest to #support."
}
EOF
{
  "metadata": "<string>",
  "messages": [
    {}
  ],
  "job_id": "<string>",
  "runchat_id": "<string>",
  "error": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication using Runchat API key. API keys can be created from the account menu

Path Parameters

​
runchat_job_id
string
required

The unique identifier for the Runchat job. Jobs are created from the Tasks dashboard and back either a flow run or a saved agent chat.

Body

application/json

Optional payload for triggering an agent job. If message is set it is appended as a user message after the saved chat template. If message is absent, the entire body is JSON-stringified and appended as the user message.

​
message
string

User message to append to the saved chat template before running the agent loop.

Response

Successful agent execution.

Response shape for agent-backed job runs.

​
metadata
string<json>

Stringified JSON containing the agent run metadata (token counts, credits, etc.).

​
messages
object[]

Final transcript including the saved template, any appended user message, and the agent's responses.

​
job_id
string

The job identifier.

​
runchat_id
string

The underlying Runchat identifier.

​
status
enum<string>

Outcome of the agent run.

Available options:
success,
error
​
error
string

Error message, present only when status is error.