Skip to main content
POST
/
v1
/
actions
/
{id}
Error
A valid request URL is required to generate request examples
{
  "action_id": "<string>",
  "name": "<string>",
  "prompt": "<string>",
  "enabled": true,
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "schedule": {
    "hour": "<string>",
    "weekday": "<string>",
    "month_day": "<string>",
    "timezone": "<string>"
  },
  "trigger": {
    "created_by": [
      "<string>"
    ]
  },
  "scope": {
    "asset_ids": [
      "<string>"
    ],
    "chat_ids": [
      "<string>"
    ],
    "label_ids": [
      "<string>"
    ],
    "concept_ids": [
      "<string>"
    ],
    "project_ids": [
      "<string>"
    ],
    "view_ids": [
      "<string>"
    ]
  },
  "email": {
    "to": [
      "jsmith@example.com"
    ],
    "subject": "<string>",
    "include_date_in_subject": true
  }
}

Authorizations

​
X-API-Key
string
header
required

Personal Access Token, sent verbatim as pat_<32 chars>. PATs are minted from the Chief settings UI.

Headers

​
X-Project-Id
string
required

Project identifier scoping the request. Required on every project-scoped public endpoint. Missing or malformed values respond with HTTP 400 and code publicapi.tenancy.project.missing.

Pattern: ^project_[a-z0-9]{20}$

Path Parameters

​
id
string
required

Action identifier returned by POST /v1/actions.

Pattern: ^action_[a-z0-9]{20}$

Body

application/json

Create/update body for an action. Provide exactly one of schedule or trigger. On update all fields are replaced — send the full desired state.

​
name
string
required
Required string length: 2 - 128
​
prompt
string
required

Plain-text prompt the action runs. Stored base64-encoded.

​
description
string
Maximum string length: 256
​
schedule
object

Cron specification carried on both the request and the response. A field set to * matches every value.

​
trigger
object

Fires the action when content lands in the project. Mutually exclusive with schedule.

​
scope
object

Knowledge the run may consult. Only asset_ids, label_ids, concept_ids, and view_ids apply to actions.

​
email
object

Email sent when a run completes.

​
enabled
boolean

Honored on update to pause or resume. Create always starts enabled.

Response

Action updated.

​
action_id
string
required
Pattern: ^action_[a-z0-9]{20}$
​
name
string
required
​
prompt
string
required

Plain-text prompt, decoded from storage.

​
enabled
boolean
required
​
created_at
string<date-time>
required
​
modified_at
string<date-time>
required
​
description
string
​
schedule
object

Cron specification carried on both the request and the response. A field set to * matches every value.

​
trigger
object

Fires the action when content lands in the project. Mutually exclusive with schedule.

​
scope
object

Caller-supplied references the assistant may consult on this turn. Tenancy (org, workspace, project) is derived from the X-Project-Id header and is never carried here.

​
email
object

Email sent when a run completes.