Every API here is available over the APIs.io API and to AI agents over MCP.
{
"openapi": "3.0.3",
"info": {
"title": "Fusio",
"description": "Self-Hosted API Management for Builders.",
"version": "1"
},
"servers": [
{
"url": "https://demo.fusio-project.org"
}
],
"paths": {
"/consumer/activate": {
"post": {
"tags": [
"account"
],
"description": "Activates an previously registered account through a token which was provided to the user via email",
"operationId": "consumer.account.activate",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Consumer_UserActivate"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common_Message"
}
}
}
},
"4XX": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common_Message"
}
}
}
},
"5XX": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common_Message"
}
}
}
}
}
}
},
"/consumer/authorize": {
"get": {
"tags": [
"account"
],
"description": "Returns information about a specific app to start the OAuth2 authorization code flow",
"operationId": "consumer.account.getApp",
"parameters": [
{
"name": "client_id",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "scope",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Consumer_AuthorizeMeta"
}
}
}
},
"4XX": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common_Message"
}
}
}
},
"5XX": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common_Message"
}
}
}
}
}
},
"post": {
"tags": [
"account"
],
"description": "Authorizes the access of a specific app for the authenticated user",
"operationId": "consumer.account.authorize",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Consumer_AuthorizeRequest"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Consumer_AuthorizeResponse"
}
}
}
},
"4XX": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common_Message"
}
}
}
},
"5XX": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common_Message"
}
}
}
}
}
}
},
"/consumer/account/change_password": {
"put": {
"tags": [
"account"
],
"description": "Change the password for the authenticated user",
"operationId": "consumer.account.changePassword",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Backend_AccountChangePassword"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common_Message"
}
}
}
},
"4XX": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common_Message"
}
}
}
},
"5XX": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common_Message"
}
}
}
}
},
"security": [
{
"app": [
"consumer.account"
]
}
]
}
},
"/consumer/password_reset": {
"put": {
"tags": [
"account"
],
"description": "Change the password after the password reset flow was started",
"operationId": "consumer.account.executePasswordReset",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Consumer_UserPasswordReset"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common_Message"
}
}
}
},
"4XX": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common_Message"
}
}
}
},
"5XX": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common_Message"
}
}
}
}
}
},
"post": {
"tags": [
"account"
],
"description": "Start the password reset flow",
"operationId": "consumer.account.requestPasswordReset",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Consumer_UserEmail"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common_Message"
}
}
}
},
"4XX": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common_Message"
}
}
}
},
"5XX": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common_Message"
}
}
}
}
}
}
},
"/consumer/account": {
"get": {
"tags": [
"account"
],
"description": "Returns a user data for the authenticated user",
"operationId": "consumer.account.get",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Consumer_UserAccount"
}
}
}
},
"4XX": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common_Message"
}
}
}
},
"5XX": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common_Message"
}
}
}
}
},
"security": [
{
"app": [
"consumer.account"
]
}
]
},
"put": {
"tags": [
"account"
],
"description": "Updates user data for the authenticated user",
"operationId": "consumer.account.update",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Consumer_UserAccount"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common_Message"
}
}
}
},
"4XX": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common_Message"
}
}
}
},
"5XX": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common_Message"
}
}
}
}
},
"security": [
{
"app": [
"consumer.account"
]
}
]
}
},
"/consumer/login": {
"put": {
"tags": [
"account"
],
"description": "Refresh a previously obtained access token",
"operationId": "consumer.account.refresh",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Consumer_UserRefresh"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Consumer_UserJWT"
}
}
}
},
"4XX": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common_Message"
}
}
}
},
"5XX": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common_Message"
}
}
}
}
}
},
"post": {
"tags": [
"account"
],
"description": "User login by providing a username and password",
"operationId": "consumer.account.login",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Consumer_UserLogin"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Consumer_UserJWT"
}
}
}
},
"4XX": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common_Message"
}
}
}
},
"5XX": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common_Message"
}
}
}
}
}
}
},
"/consumer/register": {
"post": {
"tags": [
"account"
],
"description": "Register a new user account",
"operationId": "consumer.account.register",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Consumer_UserRegister"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common_Message"
}
}
}
},
"4XX": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common_Message"
}
}
}
},
"5XX": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common_Message"
}
}
}
}
}
}
},
"/consumer/agent/{agent_id}": {
"get": {
"tags": [
"agent"
],
"description": "Returns a specific agent",
"operationId": "consumer.agent.get",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Consumer_Agent"
}
}
}
},
"4XX": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common_Message"
}
}
}
},
"5XX": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common_Message"
}
}
}
}
},
"security": [
{
"app": [
"consumer.agent"
]
}
]
},
"parameters": [
{
"name": "agent_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"/consumer/agent": {
"get": {
"tags": [
"agent"
],
"description": "Returns a paginated list of agents",
"operationId": "consumer.agent.getAll",
"parameters": [
{
"name": "startIndex",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "count",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "search",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Consumer_AgentCollection"
}
}
}
},
"4XX": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common_Message"
}
}
}
},
"5XX": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common_Message"
}
}
}
}
},
"security": [
{
"app": [
"consumer.agent"
]
}
]
}
},
"/consumer/agent/{agent_id}/message": {
"get": {
"tags": [
"agent"
],
"description": "Returns a paginated list of agent messages",
"operationId": "consumer.agent.message.getAll",
"parameters": [
{
"name": "chat_id",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Consumer_AgentMessageCollection"
}
}
}
},
"4XX": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common_Message"
}
}
}
},
"5XX": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common_Message"
}
}
}
}
},
"security": [
{
"app": [
"consumer.agent"
]
}
]
},
"post": {
"tags": [
"agent"
],
"description": "Submits a new agent message",
"operationId": "consumer.agent.message.submit",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Agent_Input"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Agent_Output"
}
}
}
},
"4XX": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common_Message"
}
}
}
},
"5XX": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common_Message"
}
}
}
}
},
"security": [
{
"app": [
"consumer.agent"
]
}
]
},
"parameters": [
{
"name": "agent_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"/consumer/app": {
"get": {
"tags": [
"app"
],
"description": "Returns a paginated list of apps which are assigned to the authenticated user",
"operationId": "consumer.app.getAll",
"parameters": [
{
"name": "startIndex",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "count",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "search",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Consumer_AppCollection"
}
}
}
},
"4XX": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common_Message"
}
}
}
},
"5XX": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common_Message"
}
}
}
}
},
# --- truncated at 32 KB (149 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/fusio/refs/heads/main/openapi/fusio-consumer.json