Skip to main content
GET
/
procedures
/
{procedure_id}
Get a procedure
curl --request GET \
  --url https://api.operator.xyz/procedures/{procedure_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Operator-Version: <operator-version>'
{
  "id": "<string>",
  "livemode": true,
  "name": "<string>",
  "conversation_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "status": "pending",
  "agent_id": null,
  "agent_version_id": null,
  "error": null,
  "input": null,
  "output": null,
  "summary": null
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
Operator-Version
enum<string>
required

The API version to use.

Available options:
2025-06-19

Path Parameters

​
procedure_id
string
required

The ID of the procedure to retrieve

Response

Successful response.

​
id
string
required

Unique identifier for the procedure

​
livemode
boolean
required

Whether the procedure was run in live mode

​
name
string
required

Name of the procedure

​
conversation_id
string
required

ID of the conversation this procedure was run for

​
created_at
string<date-time>
required

Timestamp when the procedure was created

​
status
enum<string>
required

Current status of the procedure

Available options:
pending,
running,
success,
failed,
skipped,
cancelled
​
agent_id
string

ID of the procedural agent that ran this procedure

​
agent_version_id
string

Version ID of the procedural agent that ran this procedure

​
error
string

Error message if the procedure failed

​
input
object

Input data to the procedure

​
output
object

Output data from the procedure

​
summary
string

Summary of the procedure execution