---
updatedAt: 2025-09-24T23:46:04.000Z
agentTools:
  projectIndex: https://docs.apimetrics.io/llms.txt
---

# Workflow Object

Description of the JSON for a Workflow.

Workflows are a list of API Calls that are called one after the other. This object defines how they are configured.

| Name     | Description | Required? |
| :------- | :---------- | :-------- |
| meta     | See below   | Y         |
| access   | See below   | N         |
| workflow | See below   | Y         |

## Section: meta

| Name        | Description                                   | Required?      |
| :---------- | :-------------------------------------------- | :------------- |
| name        | Name of call, for your reference              | Yes            |
| description | Description of call, for your reference       | No             |
| tags        | List of tags for the call, for your reference | No             |
| owner       | The ID of the Call Owner                      | No - read-only |

## Section: access

| Name   | Description                                           | Required? |
| :----- | :---------------------------------------------------- | :-------- |
| public | Is the workflow shared with the APImetrics community? | N         |
| org    | Is the workflow shared with your Organization?        | N         |

## Section: workflow

| Name              | Description                                                                | Required? |
| :---------------- | :------------------------------------------------------------------------- | :-------- |
| call\_ids         | List of API Call IDs in the order you want them called                     | N         |
| stop\_on\_failure | Should the workflow stop if we get an error response from one of the APIs? | N         |
| handle\_cookies   | Should cookies be handled and passed between API calls?                    | N         |