Zapier AI Actions

{
  "type": "object",
  "title": "ErrorResponse",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "string",
      "title": "Error",
      "description": "Error message."
    }
  }
}

{
  "type": "object",
  "title": "ExecuteRequest",
  "required": [
    "instructions"
  ],
  "properties": {
    "instructions": {
      "type": "string",
      "title": "Instructions",
      "description": "Plain english instructions. Provide as much detail as possible, even if other fields are present."
    },
    "preview_only": {
      "type": "boolean",
      "title": "Preview Only",
      "default": false,
      "description": "If true, we will not execute the action, but will return the params of the preview."
    }
  },
  "description": "This extends from ExecuteRequestBase to add the preview_only option.\n\n(1) Providers who allow side effects or (2) actions that do not have a side effect should use this class."
}

{
  "type": "object",
  "title": "ExecuteResponse",
  "required": [
    "id",
    "action_used",
    "input_params",
    "review_url",
    "additional_results"
  ],
  "properties": {
    "id": {
      "type": "string",
      "title": "Id",
      "description": "The id of the execution log."
    },
    "error": {
      "type": "string",
      "title": "Error",
      "description": "The error message if the execution failed."
    },
    "result": {
      "type": "object",
      "title": "Result",
      "description": "A trimmed down result of the first item of the full results. Ideal for humans and language models!"
    },
    "status": {
      "enum": [
        "success",
        "error",
        "empty",
        "preview"
      ],
      "type": "string",
      "title": "Status",
      "default": "success",
      "description": "The status of the execution."
    },
    "review_url": {
      "type": "string",
      "title": "Review Url",
      "description": "The URL to run the action or review the AI choices the AI made for input_params given instructions."
    },
    "action_used": {
      "type": "string",
      "title": "Action Used",
      "description": "The name of the action that was executed."
    },
    "input_params": {
      "type": "object",
      "title": "Input Params",
      "description": "The params we used / will use to execute the action."
    },
    "assistant_hint": {
      "type": "string",
      "title": "Assistant Hint",
      "description": "A hint for the assistant on what to do next."
    },
    "additional_results": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "title": "Additional Results",
      "description": "The rest of the full results. Always returns an array of objects"
    },
    "result_field_labels": {
      "type": "object",
      "title": "Result Field Labels",
      "description": "Human readable labels for some of the keys in the result."
    }
  },
  "description": "This is a summary of the results given the action that was executed."
}

{
  "type": "object",
  "title": "ExposedActionResponseSchema",
  "required": [
    "results",
    "configuration_link"
  ],
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ExposedActionSchema"
      },
      "title": "Results"
    },
    "configuration_link": {
      "type": "string",
      "title": "Configuration Link",
      "description": "URL to configure and expose more actions."
    }
  }
}

{
  "type": "object",
  "title": "ExposedActionSchema",
  "required": [
    "id",
    "operation_id",
    "description",
    "params"
  ],
  "properties": {
    "id": {
      "type": "string",
      "title": "Id",
      "description": "The unique ID of the exposed action."
    },
    "params": {
      "type": "object",
      "title": "Params",
      "description": "Available hint fields for the action."
    },
    "description": {
      "type": "string",
      "title": "Description",
      "description": "Description of the action."
    },
    "operation_id": {
      "type": "string",
      "title": "Operation Id",
      "description": "The operation ID of the exposed action."
    }
  }
}