The Flatfile API enables programmatic management of every primitive in the Flatfile platform: accounts, environments, spaces, workbooks, sheets, records, snapshots, commits, versions, files, documents, jobs, events, agents, agent exports, actions, mappings, runbooks, data clips, canvas areas, views, flags, secrets, roles, users, guests, entitlements, apps, auth, data retention policies, and assistant operations.
openapi: 3.1.0
info:
title: API Reference
version: 1.0.0
paths:
/accounts/current:
get:
operationId: get-current
summary: Get the current account
description: Get the current account
tags:
- subpackage_accounts
parameters:
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_accounts:AccountResponse'
patch:
operationId: update-current
summary: Update the current account
description: Update the current account
tags:
- subpackage_accounts
parameters:
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_accounts:AccountResponse'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/type_accounts:AccountPatch'
/actions:
post:
operationId: create
summary: Create an action
tags:
- subpackage_actions
parameters:
- name: spaceId
in: query
description: The Space ID for which to create the Action.
required: true
schema:
$ref: '#/components/schemas/type_commons:SpaceId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_actions:APIActionResponse'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons:APIActionConfig'
get:
operationId: get-all
summary: Get all actions for the space
tags:
- subpackage_actions
parameters:
- name: spaceId
in: query
description: The Space ID for which to get the Actions.
required: true
schema:
$ref: '#/components/schemas/type_commons:SpaceId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_actions:APIActionsResponse'
/actions/bulk:
post:
operationId: bulk-create
summary: Create several actions
tags:
- subpackage_actions
parameters:
- name: spaceId
in: query
description: The Space ID for which to create the Actions.
required: true
schema:
$ref: '#/components/schemas/type_commons:SpaceId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_actions:APIActionsResponse'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/type_actions:APIActionConfigs'
/actions/{actionId}:
get:
operationId: get
summary: Get an action
tags:
- subpackage_actions
parameters:
- name: actionId
in: path
description: The id of the action to return
required: true
schema:
$ref: '#/components/schemas/type_commons:ActionId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_actions:APIActionResponse'
patch:
operationId: update
summary: Update an action
tags:
- subpackage_actions
parameters:
- name: actionId
in: path
description: The id of the action to patch
required: true
schema:
$ref: '#/components/schemas/type_commons:ActionId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_actions:APIActionResponse'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons:ActionUpdate'
delete:
operationId: delete
summary: Delete an action
tags:
- subpackage_actions
parameters:
- name: actionId
in: path
description: The id of the action to delete
required: true
schema:
$ref: '#/components/schemas/type_commons:ActionId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons:Success'
/agent-exports:
get:
operationId: list
summary: List agent exports
tags:
- subpackage_agent-exports
parameters:
- name: environmentId
in: query
required: false
schema:
$ref: '#/components/schemas/type_commons:EnvironmentId'
- name: agentId
in: query
required: false
schema:
$ref: '#/components/schemas/type_commons:AgentId'
- name: pageSize
in: query
required: false
schema:
$ref: '#/components/schemas/type_commons:PageSize'
- name: pageNumber
in: query
required: false
schema:
$ref: '#/components/schemas/type_commons:PageNumber'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_agent-exports:ListAgentExportsResponse'
/agent-exports/{agentExportId}:
get:
operationId: get
summary: Get an agent export
tags:
- subpackage_agent-exports
parameters:
- name: agentExportId
in: path
required: true
schema:
$ref: '#/components/schemas/type_commons:AgentExportId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_agent-exports:GetAgentExportResponse'
delete:
operationId: delete
summary: Delete an agent export
tags:
- subpackage_agent-exports
parameters:
- name: agentExportId
in: path
required: true
schema:
$ref: '#/components/schemas/type_commons:AgentExportId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons:Success'
/agent-exports/{agentExportId}/download:
get:
operationId: download
summary: Download an agent export
tags:
- subpackage_agent-exports
parameters:
- name: agentExportId
in: path
required: true
schema:
$ref: '#/components/schemas/type_commons:AgentExportId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/octet-stream:
schema:
type: string
format: binary
/agents:
get:
operationId: list
summary: List agents
tags:
- subpackage_agents
parameters:
- name: environmentId
in: query
required: true
schema:
$ref: '#/components/schemas/type_commons:EnvironmentId'
- name: isSystem
in: query
required: false
schema:
type: boolean
- name: search
in: query
required: false
schema:
type: string
- name: pageSize
in: query
required: false
schema:
$ref: '#/components/schemas/type_commons:PageSize'
- name: pageNumber
in: query
required: false
schema:
$ref: '#/components/schemas/type_commons:PageNumber'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_agents:ListAgentsResponse'
post:
operationId: create
summary: Create an agent
tags:
- subpackage_agents
parameters:
- name: environmentId
in: query
required: true
schema:
$ref: '#/components/schemas/type_commons:EnvironmentId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_agents:AgentResponse'
'400':
description: Error response with status 400
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons:Errors'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/type_agents:AgentConfig'
/agents/{agentId}:
get:
operationId: get
summary: Get an agent
tags:
- subpackage_agents
parameters:
- name: agentId
in: path
required: true
schema:
$ref: '#/components/schemas/type_commons:AgentId'
- name: environmentId
in: query
required: false
schema:
$ref: '#/components/schemas/type_commons:EnvironmentId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_agents:AgentResponse'
'400':
description: Error response with status 400
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons:Errors'
'404':
description: Error response with status 404
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons:Errors'
delete:
operationId: delete
summary: Delete an agent
description: Deletes a single agent
tags:
- subpackage_agents
parameters:
- name: agentId
in: path
required: true
schema:
$ref: '#/components/schemas/type_commons:AgentId'
- name: environmentId
in: query
description: This environment variable is no longer needed or used
required: false
schema:
$ref: '#/components/schemas/type_commons:EnvironmentId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons:Success'
'400':
description: Error response with status 400
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons:Errors'
'404':
description: Error response with status 404
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons:Errors'
/agents/{agentId}/versions:
get:
operationId: list-versions
summary: List agent versions for an agent
tags:
- subpackage_agents
parameters:
- name: agentId
in: path
required: true
schema:
$ref: '#/components/schemas/type_commons:AgentId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_agents:ListAgentVersionsResponse'
'400':
description: Error response with status 400
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons:Errors'
'404':
description: Error response with status 404
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons:Errors'
/agents/{agentId}/versions/{agentVersionId}/revert:
get:
operationId: revert
summary: Revert to a specific agent version
tags:
- subpackage_agents
parameters:
- name: agentId
in: path
required: true
schema:
$ref: '#/components/schemas/type_commons:AgentId'
- name: agentVersionId
in: path
required: true
schema:
$ref: '#/components/schemas/type_commons:AgentVersionId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_agents:AgentVersionResponse'
'400':
description: Error response with status 400
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons:Errors'
'404':
description: Error response with status 404
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons:Errors'
/agents/{agentId}/roles:
get:
operationId: list-agent-roles
summary: List Agent Roles
description: Lists roles assigned to an agent.
tags:
- subpackage_agents
parameters:
- name: agentId
in: path
description: The agent id
required: true
schema:
$ref: '#/components/schemas/type_commons:AgentId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_roles:ListActorRolesResponse'
'400':
description: Error response with status 400
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons:Errors'
'403':
description: Error response with status 403
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons:Errors'
'404':
description: Error response with status 404
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons:Errors'
post:
operationId: assign-agent-role
summary: Assign Role to Agent
description: Assigns a role to a agent.
tags:
- subpackage_agents
parameters:
- name: agentId
in: path
description: The agent id
required: true
schema:
$ref: '#/components/schemas/type_commons:AgentId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_roles:AssignRoleResponse'
'400':
description: Error response with status 400
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons:Errors'
'403':
description: Error response with status 403
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons:Errors'
'404':
description: Error response with status 404
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons:Errors'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/type_roles:AssignActorRoleRequest'
/agents/{agentId}/roles/{actorRoleId}:
delete:
operationId: delete-agent-role
summary: Remove Role from Agent
description: Removes a role from an agent.
tags:
- subpackage_agents
parameters:
- name: agentId
in: path
description: The agent id
required: true
schema:
$ref: '#/components/schemas/type_commons:AgentId'
- name: actorRoleId
in: path
description: The actor role id
required: true
schema:
$ref: '#/components/schemas/type_commons:ActorRoleId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons:Success'
'400':
description: Error response with status 400
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons:Errors'
'403':
description: Error response with status 403
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons:Errors'
'404':
description: Error response with status 404
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons:Errors'
/agents/{agentId}/logs:
get:
operationId: get-agent-logs
summary: Get logs for an agent
tags:
- subpackage_agents
parameters:
- name: agentId
in: path
required: true
schema:
$ref: '#/components/schemas/type_commons:AgentId'
- name: environmentId
in: query
required: true
schema:
$ref: '#/components/schemas/type_commons:EnvironmentId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_agents:GetAgentLogsResponse'
'400':
description: Error response with status 400
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons:Errors'
'404':
description: Error response with status 404
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons:Errors'
/agents/log/{eventId}:
get:
operationId: get-agent-log
summary: Get an agent log
tags:
- subpackage_agents
parameters:
- name: eventId
in: path
required: true
schema:
$ref: '#/components/schemas/type_commons:EventId'
- name: environmentId
in: query
required: true
schema:
$ref: '#/components/schemas/type_commons:EnvironmentId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_agents:GetDetailedAgentLogResponse'
'400':
description: Error response with status 400
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons:Errors'
'404':
description: Error response with status 404
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons:Errors'
/agents/logs:
get:
operationId: get-environment-agent-logs
summary: Get all agent logs in your environment
tags:
- subpackage_agents
parameters:
- name: environmentId
in: query
required: true
schema:
$ref: '#/components/schemas/type_commons:EnvironmentId'
- name: spaceId
in: query
required: false
schema:
$ref: '#/components/schemas/type_commons:SpaceId'
- name: success
in: query
required: false
schema:
$ref: '#/components/schemas/type_commons:SuccessQueryParameter'
- name: pageSize
in: query
required: false
schema:
$ref: '#/components/schemas/type_commons:PageSize'
- name: pageNumber
in: query
required: false
schema:
$ref: '#/components/schemas/type_commons:PageNumber'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_agents:GetDetailedAgentLogsResponse'
'400':
description: Error response with status 400
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons:Errors'
'404':
description: Error response with status 404
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons:Errors'
/agents/executions:
get:
operationId: get-environment-agent-executions
summary: Get all executions in your environment
tags:
- subpackage_agents
parameters:
- name: environmentId
in: query
required: true
schema:
$ref: '#/components/schemas/type_commons:EnvironmentId'
- name: agentId
in: query
required: false
schema:
$ref: '#/components/schemas/type_commons:AgentId'
- name: spaceId
in: query
required: false
schema:
$ref: '#/components/schemas/type_commons:SpaceId'
- name: success
in: query
required: false
schema:
$ref: '#/components/schemas/type_commons:SuccessQueryParameter'
- name: pageSize
in: query
required: false
schema:
$ref: '#/components/schemas/type_commons:PageSize'
- name: pageNumber
in: query
required: false
schema:
$ref: '#/components/schemas/type_commons:PageNumber'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_agents:GetExecutionsResponse'
'400':
description: Error response with status 400
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons:Errors'
'404':
description: Error response with status 404
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons:Errors'
/apps:
get:
operationId: list
summary: List apps
description: Returns apps in an account
tags:
- subpackage_apps
parameters:
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_apps:AppsResponse'
post:
operationId: create
summary: Create an app
description: Creates an app
tags:
- subpackage_apps
parameters:
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_apps:AppResponse'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/type_apps:AppCreate'
/apps/{appId}:
get:
operationId: get
summary: Get an app
description: Returns an app
tags:
- subpackage_apps
parameters:
- name: appId
in: path
description: ID of app
required: true
schema:
$ref: '#/components/schemas/type_commons:AppId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
# --- truncated at 32 KB (693 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/flatfile/refs/heads/main/openapi/flatfile-api-openapi.yml