curl --request GET \
--url "https://api.roe-ai.com/v1/workflows/YOUR_WORKFLOW_ID/" \
--header "Authorization: Bearer YOUR_API_KEY"
{
"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"
}{
"detail": "<string>"
}Workflows
Retrieve Workflow
Get a workflow with its current version.
GET
/
v1
/
workflows
/
{workflow_id}
/
curl --request GET \
--url "https://api.roe-ai.com/v1/workflows/YOUR_WORKFLOW_ID/" \
--header "Authorization: Bearer YOUR_API_KEY"
{
"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"
}{
"detail": "<string>"
}curl --request GET \
--url "https://api.roe-ai.com/v1/workflows/YOUR_WORKFLOW_ID/" \
--header "Authorization: Bearer YOUR_API_KEY"
Authorizations
Organization API key passed as a Bearer token. This is the scheme used by the public SDK surface.
Path Parameters
Query Parameters
Organization ID. This is required for access control. It can be provided via query or request body depending on the endpoint.
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