Skip to main content
POST
/
agents
/
{agentId}
/
threads
/
{threadId}
/
steer
JavaScript
import Cerca from '@cerca-dev/sdk';

const client = new Cerca({
  apiKey: process.env['CERCA_API_KEY'], // This is the default and can be omitted
});

const steerResult = await client.threads.steer('agent_abc123', 'thread_abc123', {
  message: 'message',
});

console.log(steerResult.status);
{
  "turnId": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.cerca.dev/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
agentId
string
required
Minimum string length: 1
Example:

"agent_abc123"

​
threadId
string
required
Minimum string length: 1
Example:

"thread_abc123"

Body

application/json
​
message
string
required
​
{key}
any

Response

Thread steer result.

​
status
enum<string>
required
Available options:
enqueued,
turn_started
​
threadStatus
enum<string>
required

idle threads can accept a new turn or be closed. running threads have an active turn. awaiting threads are paused on external input such as approvals. closed threads are terminal.

Available options:
idle,
running,
awaiting,
closed
​
turnId
string
required