Help us improve our product documentation on docs.cognigy.com by sharing your thoughts in a quick survey. Your feedback shapes the future of our content!
Overview
API
- GETGet Playbooks
- POSTCreate a Playbook
- PATCHPerform Batch Operations
- GETGet a Playbook
- DELDelete a Playbook
- PATCHUpdate a Playbook
- GETList Playbook Runs
- GETRetrieve a Playbook Run
- DELDelete a Playbook Run
- POSTSchedule a Playbook Run
- POSTCreate a Playbook Step
- DELDelete a Playbook Step
- PATCHUpdate a Playbook Step
- POSTCreate an Assertion
- DELDelete a Playbook Step Assert
- PATCHUpdate a Playbook Step Assert
- POSTChange Step Order
Help us improve our product documentation on docs.cognigy.com by sharing your thoughts in a quick survey. Your feedback shapes the future of our content!
Retrieve a Playbook Run
Retrieves data about a Playbook run.
curl --request GET \
--url https://api-trial.cognigy.ai/new/v2.0/playbooks/{playbookId}/runs/{playbookRunId} \
--header 'X-API-Key: <api-key>'{
"status": "successful",
"_id": "<string>",
"createdAt": 1694518620,
"lastChanged": 1694518620,
"createdBy": "<string>",
"lastChangedBy": "<string>",
"stepResults": [
{
"status": "failed",
"text": "Hello, how are you?",
"data": {},
"_id": "<string>",
"asserts": [
{
"type": "assertText",
"status": "failed",
"params": {},
"negate": false,
"actual": {},
"_id": "<string>"
}
],
"timeout": true
}
],
"flowId": "uuid",
"localeId": "uuid",
"entrypoint": "^[a-z0-9]{24}$"
}Documentation Index
Fetch the complete documentation index at: https://docs.cognigy.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Supply the API Key in the HTTP-Header
Headers
The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.
application/json, application/hal+json, application/xml, text/xml, text/csv Path Parameters
The Id of the Playbook
24^[a-z0-9]{24}$The Id of the Playbook Run
24^[a-z0-9]{24}$Response
Returns Playbook Run object
The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.
Whether the playbook run was successful or failed
successful, failed "successful"
24^[a-z0-9]{24}$Unix-timestamp
0 <= x <= 21474836471694518620
Unix-timestamp
0 <= x <= 21474836471694518620
24^[a-z0-9]{24}$24^[a-z0-9]{24}$Show child attributes
Show child attributes
Reference Id of the flow
"uuid"
Reference Id of the locale
"uuid"
snapshot or project ID
"^[a-z0-9]{24}$"
curl --request GET \
--url https://api-trial.cognigy.ai/new/v2.0/playbooks/{playbookId}/runs/{playbookRunId} \
--header 'X-API-Key: <api-key>'{
"status": "successful",
"_id": "<string>",
"createdAt": 1694518620,
"lastChanged": 1694518620,
"createdBy": "<string>",
"lastChangedBy": "<string>",
"stepResults": [
{
"status": "failed",
"text": "Hello, how are you?",
"data": {},
"_id": "<string>",
"asserts": [
{
"type": "assertText",
"status": "failed",
"params": {},
"negate": false,
"actual": {},
"_id": "<string>"
}
],
"timeout": true
}
],
"flowId": "uuid",
"localeId": "uuid",
"entrypoint": "^[a-z0-9]{24}$"
}