Executions

An execution is a single run of an app, it contains the inputs, outputs, and status of the run, and can be used to check the status of the run.

Retrieve an execution

get

Returns the execution with the given uuid. You can use this endpoint to check the status of the execution.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

execution_uuidstringRequired

The execution uuid

Responses

200

Execution found

application/json

401

Authentication error

get

/public_api/airops_apps/executions/{execution_uuid}

GET /public_api/airops_apps/executions/{execution_uuid} HTTP/1.1
Host: api.airops.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 22,
  "status": "success",
  "airops_apps_version_id": 21,
  "conversation_id": 23,
  "credits_used": 34,
  "error_code": null,
  "error_message": null,
  "feedback": "positive",
  "inputs": {
    "name": "John Doe"
  },
  "output": {
    "greet": "Hello John Doe!"
  },
  "runtime": 34,
  "source": null,
  "uuid": "c3405f16-d0e8-4d5c-8ad9-85ef332c44ee",
  "workspace_id": 1,
  "createdAt": "2024-02-01 16:39:28.161000000 Z",
  "updatedAt": "2024-02-01 16:39:28.161000000 Z"
}

Execute

post

This endpoint allows you to execute an app. You can use this endpoint to execute an app and get the output of the execution.

Preconditions: the app must be published.

This endpoint executes the app immediately and returns the result, unless you are at your current capacity, or your app takes more than 10 minutes to run, in which case it will fail.

If you want to execute an app asynchronously, use the async_execute endpoint.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_uuidstringRequired

The app uuid

Body

version_slugintegerOptional

The version of the app (will use the default version if not provided)

Example: 12

inputsobjectRequired

The inputs of the app

Example: {"name":"John Doe"}

Responses

200

Execution created

application/json

400

Invalid input

application/json

401

Authentication error

post

/public_api/airops_apps/{app_uuid}/execute

POST /public_api/airops_apps/{app_uuid}/execute HTTP/1.1
Host: api.airops.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "inputs": {
    "name": "John Doe"
  }
}

{
  "id": 22,
  "status": "success",
  "airops_apps_version_id": 21,
  "conversation_id": 23,
  "credits_used": 34,
  "error_code": null,
  "error_message": null,
  "feedback": "positive",
  "inputs": {
    "name": "John Doe"
  },
  "output": {
    "greet": "Hello John Doe!"
  },
  "runtime": 34,
  "source": null,
  "uuid": "c3405f16-d0e8-4d5c-8ad9-85ef332c44ee",
  "workspace_id": 1,
  "createdAt": "2024-02-01 16:39:28.161000000 Z",
  "updatedAt": "2024-02-01 16:39:28.161000000 Z"
}

Async Execute

post

This endpoint allows you to execute an app asynchronously. You can use this endpoint to execute an app and get the execution id to check the status of the execution.

Preconditions: the app must be published.

Executions created through this endpoint will be queued and executed at your workspace's capacity.

If you want to execute an app immediately, use the execute endpoint.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_uuidstringRequired

The app uuid, you can find the app uuid by going to the App => Integrate

Body

version_slugintegerOptional

The version of the app (will use the default version if not provided)

Example: 12

inputsobjectRequired

The inputs of the app

Example: {"name":"John Doe"}

Responses

200

Execution created

application/json

400

Invalid input

application/json

401

Authentication error

post

/public_api/airops_apps/{app_uuid}/async_execute

POST /public_api/airops_apps/{app_uuid}/async_execute HTTP/1.1
Host: api.airops.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "inputs": {
    "name": "John Doe"
  }
}

{
  "id": 22,
  "status": "pending",
  "airops_apps_version_id": 21,
  "conversation_id": null,
  "credits_used": 34,
  "error_code": null,
  "error_message": null,
  "feedback": null,
  "inputs": {
    "name": "John Doe"
  },
  "output": null,
  "runtime": null,
  "source": null,
  "uuid": "c3405f16-d0e8-4d5c-8ad9-85ef332c44ee",
  "workspace_id": 1,
  "createdAt": "2024-02-01 16:39:28.161000000 Z",
  "updatedAt": "2024-02-01 16:39:28.161000000 Z"
}

Execute Workflow Definition

post

This endpoint allows you to execute a workflow definition. You can use this endpoint to execute a workflow definition and get the execution id to check the status of the execution.

Preconditions: the app must be published.

This endpoint executes the app immediately and returns the result, unless you are at your current capacity, or your app takes more than 10 minutes to run, in which case it will fail.

If you want to execute an app asynchronously, use the async_execute_definition endpoint.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_uuidstringRequired

The app uuid

Body

inputsobjectRequired

The inputs of the workflow

Example: {"name":"John Doe"}

Responses

200

Execution created

application/json

400

Invalid input

application/json

401

Authentication error

post

/public_api/airops_apps/{app_uuid}/execute_definition

POST /public_api/airops_apps/{app_uuid}/execute_definition HTTP/1.1
Host: api.airops.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 734

{
  "inputs": {
    "name": "John Doe"
  },
  "inputs_schema": [
    {
      "interface": "long_text",
      "label": "Name",
      "name": "name",
      "hint": "Enter your name",
      "required": true,
      "group_id": "no-group",
      "action_id": "name",
      "placeholder": "Enter your name",
      "test_value": "John Doe",
      "options": []
    }
  ],
  "definition": [
    {
      "name": "step_1",
      "type": "llm",
      "config": {
        "model": "gpt-3.5-turbo-instruct",
        "soft_fail": false,
        "config": {
          "prompt": "Provide a nickname for {{inputs.name}}",
          "request_consistent_results": true,
          "response_format": "text",
          "stream": false,
          "temperature": 0.5,
          "note": "",
          "model_source": "airops",
          "max_tokens": 100
        }
      }
    },
    {
      "name": "step_2",
      "type": "app",
      "config": {
        "app_id": 1,
        "inputs": {
          "name": "{{step_1.output}}"
        }
      }
    },
    {
      "name": "step_3",
      "type": "text",
      "config": {
        "text": "Hello {{step_2.output}}!"
      }
    }
  ]
}

{
  "id": 22,
  "status": "success",
  "airops_apps_version_id": 21,
  "conversation_id": 23,
  "credits_used": 34,
  "error_code": null,
  "error_message": null,
  "feedback": "positive",
  "inputs": {
    "name": "John Doe"
  },
  "output": {
    "greet": "Hello John Doe!"
  },
  "runtime": 34,
  "source": null,
  "uuid": "c3405f16-d0e8-4d5c-8ad9-85ef332c44ee",
  "workspace_id": 1,
  "createdAt": "2024-02-01 16:39:28.161000000 Z",
  "updatedAt": "2024-02-01 16:39:28.161000000 Z"
}

Async Execute Workflow Definition

post

This endpoint allows you to execute a workflow definition asynchronously. You can use this endpoint to execute a workflow definition and get the execution id to check the status of the execution.

Preconditions: the app must be published.

Executions created through this endpoint will be queued and executed at your workspace's capacity.

If you want to execute a workflow definition immediately, use the execute_definition endpoint.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_uuidstringRequired

The app uuid, you can find the app uuid by going to the App => Integrate

Body

inputsobjectRequired

The inputs of the workflow

Example: {"name":"John Doe"}

Responses

200

Execution created

application/json

400

Invalid input

application/json

401

Authentication error

post

/public_api/airops_apps/{app_uuid}/async_execute_definition

POST /public_api/airops_apps/{app_uuid}/async_execute_definition HTTP/1.1
Host: api.airops.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 734

{
  "inputs": {
    "name": "John Doe"
  },
  "inputs_schema": [
    {
      "interface": "long_text",
      "label": "Name",
      "name": "name",
      "hint": "Enter your name",
      "required": true,
      "group_id": "no-group",
      "action_id": "name",
      "placeholder": "Enter your name",
      "test_value": "John Doe",
      "options": []
    }
  ],
  "definition": [
    {
      "name": "step_1",
      "type": "llm",
      "config": {
        "model": "gpt-3.5-turbo-instruct",
        "soft_fail": false,
        "config": {
          "prompt": "Provide a nickname for {{inputs.name}}",
          "request_consistent_results": true,
          "response_format": "text",
          "stream": false,
          "temperature": 0.5,
          "note": "",
          "model_source": "airops",
          "max_tokens": 100
        }
      }
    },
    {
      "name": "step_2",
      "type": "app",
      "config": {
        "app_id": 1,
        "inputs": {
          "name": "{{step_1.output}}"
        }
      }
    },
    {
      "name": "step_3",
      "type": "text",
      "config": {
        "text": "Hello {{step_2.output}}!"
      }
    }
  ]
}

{
  "id": 22,
  "status": "pending",
  "airops_apps_version_id": 21,
  "conversation_id": null,
  "credits_used": 34,
  "error_code": null,
  "error_message": null,
  "feedback": null,
  "inputs": {
    "name": "John Doe"
  },
  "output": null,
  "runtime": null,
  "source": null,
  "uuid": "c3405f16-d0e8-4d5c-8ad9-85ef332c44ee",
  "workspace_id": 1,
  "createdAt": "2024-02-01 16:39:28.161000000 Z",
  "updatedAt": "2024-02-01 16:39:28.161000000 Z"
}

Webhook Async Execute

post

This endpoint allows you to execute an app asynchronously as a webhook for an external service.

The payload of the request will be mapped to the first input of your app.

Preconditions: the app must be published.

More information on how to use this endpoint can be found here.

Path parameters

app_uuidstringRequired

The app uuid, you can find the app uuid by going to the App => Integrate

Query parameters

auth_tokenstringRequired

Your workspace API key

Example: 23iu3h23-34n43yib4-3243n34b4-34n434h

Body

version_slugintegerOptional

The version of the app (will use the default version if not provided)

Example: 12

inputsobjectRequired

The inputs of the app

Example: {"name":"John Doe"}

Responses

200

Execution created

application/json

400

Invalid input

application/json

401

Authentication error

post

/public_api/airops_apps/{app_uuid}/webhook_async_execute

POST /public_api/airops_apps/{app_uuid}/webhook_async_execute?auth_token=23iu3h23-34n43yib4-3243n34b4-34n434h HTTP/1.1
Host: api.airops.com
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "inputs": {
    "name": "John Doe"
  }
}

[
  {
    "id": 22,
    "status": "success",
    "airops_apps_version_id": 21,
    "conversation_id": 23,
    "credits_used": 34,
    "error_code": null,
    "error_message": null,
    "feedback": "positive",
    "inputs": {
      "name": "John Doe"
    },
    "output": {
      "greet": "Hello John Doe!"
    },
    "runtime": 34,
    "source": null,
    "uuid": "c3405f16-d0e8-4d5c-8ad9-85ef332c44ee",
    "workspace_id": 1,
    "createdAt": "2024-02-01 16:39:28.161000000 Z",
    "updatedAt": "2024-02-01 16:39:28.161000000 Z"
  }
]

Cancel an execution

patch

This endpoint allows you to cancel an execution.

Preconditions: the execution must be in the pending or running status.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

execution_uuidstringRequired

The execution uuid

Responses

204

Execution cancelled

401

Authentication error

patch

/public_api/airops_apps/executions/{execution_uuid}/cancel

PATCH /public_api/airops_apps/executions/{execution_uuid}/cancel HTTP/1.1
Host: api.airops.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Retry an execution

post

This endpoint allows you to retry an execution from the last failed step.

Preconditions: the execution must be in the error status.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

execution_uuidstringRequired

The execution uuid

Responses

204

Execution retried

400

Execution is not in error status

401

Authentication error

post

/public_api/airops_apps/executions/{execution_uuid}/retry

POST /public_api/airops_apps/executions/{execution_uuid}/retry HTTP/1.1
Host: api.airops.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Rate an execution

patch

This endpoint allows you to rate an execution.

Preconditions: the execution must be in the success status.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

execution_uuidstringRequired

The execution uuid

Body

feedbackstring · enumRequired

The feedback of the execution

Example: positivePossible values:

Responses

204

Feedback sent

401

Authentication error

patch

/public_api/airops_apps/executions/{execution_uuid}/feedback

PATCH /public_api/airops_apps/executions/{execution_uuid}/feedback HTTP/1.1
Host: api.airops.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "feedback": "positive"
}

No content

Retrieve all executions for an Airops app

get

Returns all the executions for a given Airops app. You can use this endpoint to check the status/input/output of all the executions.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

airops_app_idintegerRequired

The Airops app ID to fetch executions from

cursorstringOptional

The cursor value to use for pagination

itemsinteger · min: 1 · max: 100Optional

The amount of items to fetch

Example: 10

Responses

200

Executions found

application/json

401

Authentication error

get

/public_api/airops_apps/:airops_app_id/executions

GET /public_api/airops_apps/:airops_app_id/executions?airops_app_id=1 HTTP/1.1
Host: api.airops.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "data": [
      {
        "id": 22,
        "status": "success",
        "airops_apps_version_id": 21,
        "conversation_id": 23,
        "credits_used": 34,
        "error_code": null,
        "error_message": null,
        "feedback": "positive",
        "inputs": {
          "name": "John Doe"
        },
        "output": {
          "greet": "Hello John Doe!"
        },
        "runtime": 34,
        "source": null,
        "uuid": "c3405f16-d0e8-4d5c-8ad9-85ef332c44ee",
        "workspace_id": 1,
        "createdAt": "2024-02-01 16:39:28.161000000 Z",
        "updatedAt": "2024-02-01 16:39:28.161000000 Z"
      }
    ],
    "meta": {
      "count": 2,
      "has_more": true,
      "cursor": 22
    }
  }
]

Last updated 42 minutes ago

Was this helpful?

Good night

hashtagRetrieve an execution

hashtagExecute

hashtagAsync Execute

hashtagExecute Workflow Definition

hashtagAsync Execute Workflow Definition

hashtagWebhook Async Execute

hashtagCancel an execution

hashtagRetry an execution

hashtagRate an execution

hashtagRetrieve all executions for an Airops app

Retrieve an execution

Execute

Async Execute

Execute Workflow Definition

Async Execute Workflow Definition

Webhook Async Execute

Cancel an execution

Retry an execution

Rate an execution

Retrieve all executions for an Airops app