goals
List Goals
List the authenticated owner's active, listed Goals that have a published RunSpec. For example, a fulfillment service can inspect the published interface for its reusable delivery-confirmation workflow before creating phone-specific Runs.
Results are ordered by opaque Goal identity. Use next_cursor as the next request's
after value; clients must not parse or construct cursor values. title and description
help operators recognize each published workflow, but integrations should still store the
intended goal_id at publish time and must not execute the first list item blindly.
query Parameters
limitMaximum number of Goal interfaces in this page. Defaults to 20; values below 1 or above
100 return 400 invalid_request. A page can contain fewer items even when the limit is
larger. Continue only when next_cursor is non-null.
afterOpaque cursor returned as next_cursor by the immediately preceding list response. Pass it
unchanged together with the desired limit. Do not decode it, construct it from a Goal id,
or persist assumptions about its format. Omit this parameter for the first page.
List Goals › Responses
Page of executable published Goal interfaces.
objectAlways list for paginated list responses.
Goal interfaces in stable opaque-id order. Do not assume the first item is the Goal your
workflow should execute; store the intended goal_id when it is published.
next_cursorOpaque cursor for the next page. null means there are no more Goals.
Get Goal
Get an owner-scoped active Goal and its currently published immutable RunSpec interface.
Store the goal_id returned by Chat publish success. title and description explain the
current published workflow. Before sending a delivery-confirmation Run, use input_schema
to verify that customer_name, order_reference, and delivery_window match the current
published version, and use result_schema to prepare downstream outcome handling.
This endpoint does not search by title, objective, or recency, and does not expose authoring instructions, provider bindings, or result materialization guidance. The server always resolves the current published pointer for a new business key.
path Parameters
goal_idOpaque public Goal identity returned by CALL-E Chat publish success or GET /v1/goals.
Store it with your integration configuration. It identifies the reusable Goal and is
different from published_run_spec.id, goal_run_id, and the nested telephone run_id.
Get Goal › Responses
Active Goal and its currently published RunSpec interface.
objectAlways goal for Goal responses.
idOpaque Goal identity. This is distinct from the nested RunSpec identity.
titleShort developer-facing title from the current published RunSpec. It may be null for an untitled Goal.
descriptionDeveloper-facing summary of what the current published Goal does. This is not the execution prompt.
statusAlways active; non-executable Goals are not returned by this surface.
Currently published immutable interface used to validate new variables and interpret
result. New business keys pin this version at acceptance time.