curl --request POST \
--url "https://api.roe-ai.com/v1/workflows/?organization_id=YOUR_ORG_ID" \
--header "Authorization: Bearer YOUR_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"name": "Customer risk review",
"definition": {
"inputs": [
{"key": "customer_id", "data_type": "text/plain", "description": "The customer to review"}
],
"steps": [
{
"kind": "agent",
"id": "check_risk",
"base_agent_id": "YOUR_AGENT_ID",
"agent_version_id": "YOUR_AGENT_VERSION_ID",
"input_mapping": {"customer": "{initial.customer_id}"}
}
],
"result": "check_risk"
}
}'
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"current_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"creator": {
"id": 123,
"email": "jsmith@example.com",
"display_name": "<string>",
"first_name": "<string>",
"last_name": "<string>"
},
"updated_at": "2023-11-07T05:31:56Z",
"current_version": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_current": true,
"read_only": true,
"definition": {
"steps": [
{
"id": "<string>",
"kind": "agent",
"base_agent_id": "<string>",
"agent_version_id": "<string>",
"input_mapping": {}
}
],
"result": "<string>",
"format_version": 2,
"inputs": [
{
"key": "<string>",
"data_type": "text/plain",
"description": "",
"required": true,
"accepts_multiple_files": false
}
]
},
"conversion_reasons": [
"<string>"
],
"version_name": "<string>",
"description": "<string>",
"format_version": 16383,
"created_at": "2023-11-07T05:31:56Z",
"input_definitions": "<unknown>"
},
"created_at": "2023-11-07T05:31:56Z"
}{}Workflows
Create Workflow
Create a workflow from a block-format definition; its first version becomes current. A definition that fails its checks returns each error with the step it belongs to.
POST
/
v1
/
workflows
/
curl --request POST \
--url "https://api.roe-ai.com/v1/workflows/?organization_id=YOUR_ORG_ID" \
--header "Authorization: Bearer YOUR_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"name": "Customer risk review",
"definition": {
"inputs": [
{"key": "customer_id", "data_type": "text/plain", "description": "The customer to review"}
],
"steps": [
{
"kind": "agent",
"id": "check_risk",
"base_agent_id": "YOUR_AGENT_ID",
"agent_version_id": "YOUR_AGENT_VERSION_ID",
"input_mapping": {"customer": "{initial.customer_id}"}
}
],
"result": "check_risk"
}
}'
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"current_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"creator": {
"id": 123,
"email": "jsmith@example.com",
"display_name": "<string>",
"first_name": "<string>",
"last_name": "<string>"
},
"updated_at": "2023-11-07T05:31:56Z",
"current_version": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_current": true,
"read_only": true,
"definition": {
"steps": [
{
"id": "<string>",
"kind": "agent",
"base_agent_id": "<string>",
"agent_version_id": "<string>",
"input_mapping": {}
}
],
"result": "<string>",
"format_version": 2,
"inputs": [
{
"key": "<string>",
"data_type": "text/plain",
"description": "",
"required": true,
"accepts_multiple_files": false
}
]
},
"conversion_reasons": [
"<string>"
],
"version_name": "<string>",
"description": "<string>",
"format_version": 16383,
"created_at": "2023-11-07T05:31:56Z",
"input_definitions": "<unknown>"
},
"created_at": "2023-11-07T05:31:56Z"
}{}curl --request POST \
--url "https://api.roe-ai.com/v1/workflows/?organization_id=YOUR_ORG_ID" \
--header "Authorization: Bearer YOUR_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"name": "Customer risk review",
"definition": {
"inputs": [
{"key": "customer_id", "data_type": "text/plain", "description": "The customer to review"}
],
"steps": [
{
"kind": "agent",
"id": "check_risk",
"base_agent_id": "YOUR_AGENT_ID",
"agent_version_id": "YOUR_AGENT_VERSION_ID",
"input_mapping": {"customer": "{initial.customer_id}"}
}
],
"result": "check_risk"
}
}'
Authorizations
Organization API key passed as a Bearer token. This is the scheme used by the public SDK surface.
Query Parameters
Organization ID. This is required for access control. It can be provided via query or request body depending on the endpoint.
Body
application/json
Response
Maximum string length:
200The workflow's id as an agent. Calling a workflow by it is deprecated; the agent_id filter finds the workflow it belongs to.
Show child attributes
Show child attributes
Show child attributes
Show child attributes