Metorial API

https://metorial.com/api/
Admin
Metorial API is a RESTful service that provides resource-oriented endpoints for managing servers,...
Tokens:55,399
Snippets:324
Trust Score:6.3
Update:11 months ago
Show doc for...
Tokens:
Raw
### Get Server Implementation Object Example

Source: https://metorial.com/api/server-implementation

Provides an example JSON object representing a server implementation. This object includes details like status, metadata, server variant, and server type. It serves as a reference for the structure of server implementation data within the Metorial API.

```json
{
  "object": "server.server_implementation",
  "status": "active",
  "metadata": {},
  "server_variant": {
    "object": "server.server_variant#preview",
    "source": {
      "type": "docker",
      "docker": {}
    }
  },
  "server": {
    "object": "server#preview",
    "type": "public"
  }
}
```

--------------------------------

### Get server deployment

Source: https://metorial.com/api/server-deployment

Fetch detailed information about a specific server deployment.

```APIDOC
## Get server deployment

### Description
Fetch detailed information about a specific server deployment.

### Method
GET

### Endpoint
/server-deployments/:server_deployment_id

### Parameters
#### Path Parameters
- **server_deployment_id** (String) - Required - The unique identifier for the server_deployment

### Request Example
```bash
curl -X GET "https://api.metorial.com/server-deployments/ser_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."
```
```

--------------------------------

### Pagination Example with Query Parameter

Source: https://metorial.com/api/index

This example shows how to use the 'after' query parameter to fetch the next page of results from a paginated endpoint. The parameter is appended to the base URL with the ID of a record from the current page.

```http
GET /sessions?after=ses_0mcsv9nhnxIQdeTerz35SzF
```

--------------------------------

### Get Server Implementation

Source: https://metorial.com/api/server-implementation

Fetches detailed information about a specific server implementation using its unique identifier.

```APIDOC
## Get server implementation

### Description
Fetch detailed information about a specific server implementation.

### Method
GET

### Endpoint
http://api.metorial.com/server-implementations/:server_implementation_id

### Parameters
#### Path Parameters
- **server_implementation_id** (String) - Required - The unique identifier for the server_implementation.

### Response
#### Success Response (200)
- **object** (String) - The object type, e.g., "server.server_implementation".
- **status** (String) - The current status of the implementation (e.g., "active").
- **metadata** (Object) - Additional metadata associated with the implementation.
- **server_variant** (Object) - Information about the server variant used.
- **server** (Object) - Information about the base server.

#### Response Example
```json
{
  "object": "server.server_implementation",
  "status": "active",
  "metadata": {},
  "server_variant": {
    "object": "server.server_variant#preview",
    "source": {
      "type": "docker",
      "docker": {}
    }
  },
  "server": {
    "object": "server#preview",
    "type": "public"
  }
}
```
```

--------------------------------

### OAuth Profile Object Example

Source: https://metorial.com/api/oauth-profile

This code snippet demonstrates the structure of an OAuth Profile object, including its object identifier and status.

```JSON
{
  "object": "provider_oauth.connection.profile",
  "status": "active"
}
```

--------------------------------

### GET /server-capabilities

Source: https://metorial.com/api/server-capabilities

Retrieves a list of server capabilities. You can filter the results by various server attributes like deployment, variant, version, and more.

```APIDOC
## List server capabilities

### Description
Returns a list of server capabilities, filterable by server attributes such as deployment, variant, or version.

### Method
GET

### Endpoint
/server-capabilities

### Query Parameters
- **limit** (Number) - Optional
- **after** (String) - Optional
- **before** (String) - Optional
- **cursor** (String) - Optional
- **order** (Enum) - Optional
- **server_deployment_id** (Union) - Optional
- **server_variant_id** (Union) - Optional
- **server_id** (Union) - Optional
- **server_version_id** (Union) - Optional
- **server_implementation_id** (Union) - Optional

### Request Example
```curl
curl -X GET "https://api.metorial.com/server-capabilities" \
  -H "Authorization: Bearer metorial_sk_..."
```

### Response
#### Success Response (200)
- **object** (String) - Indicates the type of the returned object, typically 'server.capabilities'.
- **mcp_servers** (Array) - A list of MCP servers and their capabilities.
  - Each item in the array is an object with properties like 'server', 'server_variant', 'server_version', 'server_deployment', 'capabilities', and 'info'.
- **tools** (Array) - A list of tools available on MCP servers.
- **prompts** (Array) - A list of prompts available on MCP servers.
- **resource_templates** (Array) - A list of resource templates available on MCP servers.

#### Response Example
```json
{
  "object": "server.capabilities",
  "mcp_servers": [
    {
      "object": "server.capabilities.mcp_server",
      "server": {
        "object": "server#preview",
        "type": "public"
      },
      "server_variant": {
        "object": "server.server_variant#preview",
        "source": {
          "type": "docker",
          "docker": {}
        }
      },
      "server_version": {
        "object": "server.server_version#preview",
        "source": {
          "type": "docker",
          "docker": {}
        }
      },
      "server_deployment": {
        "object": "server.server_deployment#preview",
        "metadata": {},
        "server": {
          "object": "server#preview",
          "type": "public"
        }
      },
      "capabilities": {
        "key1": {}
      },
      "info": {}
    }
  ],
  "tools": [
    {}
  ],
  "prompts": [
    {}
  ],
  "resource_templates": [
    {}
  ]
}
```
```

--------------------------------

### Get Server Deployment Details (cURL)

Source: https://metorial.com/api/server-deployment

This cURL command fetches detailed information about a specific server deployment using its unique identifier.

```curl
curl -X GET "https://api.metorial.com/server-deployments/ser_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."
```

--------------------------------

### Example Magic MCP Server Object Structure

Source: https://metorial.com/api/magic-mcp-server

This snippet shows the JSON structure of a Magic MCP Server object, including its status, endpoints, and deployment details. It serves as a reference for understanding the data associated with a server.

```json
{
  "object": "magic_mcp.server",
  "status": "active",
  "endpoints": [
    {
      "urls": {}
    },
    {
      "urls": {}
    }
  ],
  "server_deployments": [
    {
      "object": "server.server_deployment#preview",
      "metadata": {},
      "server": {
        "object": "server#preview",
        "type": "public"
      }
    },
    {
      "object": "server.server_deployment#preview",
      "metadata": {},
      "server": {
        "object": "server#preview",
        "type": "public"
      }
    }
  ],
  "metadata": {}
}
```

--------------------------------

### Get Server Implementation by ID (cURL)

Source: https://metorial.com/api/server-implementation

Shows how to fetch detailed information for a specific server implementation using its unique identifier. The server_implementation_id is a required URL parameter. Authentication via the Authorization header is necessary.

```cURL
curl -X GET "https://api.metorial.com/server-implementations/ser_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."
```

--------------------------------

### OAuth Session Object Example (JSON)

Source: https://metorial.com/api/oauth-session

This snippet shows the structure of an OAuth Session object, including its status, connection details, provider information, and configuration. It represents the data returned when interacting with OAuth sessions.

```json
{
  "object": "provider_oauth.session",
  "status": "pending",
  "connection": {
    "object": "provider_oauth.connection",
    "status": "active",
    "metadata": {},
    "provider": {
      "name": "GitHub",
      "url": "https://github.com",
      "image_url": "https://camo.metorial.com/igu4hi54high"
    },
    "config": {
      "type": "json",
      "config": {},
      "scopes": [
        "repo",
        "repo"
      ]
    }
  },
  "metadata": {}
}
```

--------------------------------

### OAuth Connection Object Example

Source: https://metorial.com/api/oauth-connection

This JSON object represents a provider OAuth connection, detailing its status, metadata, provider information, and configuration including scopes.

```json
{
  "object": "provider_oauth.connection",
  "status": "active",
  "metadata": {},
  "provider": {
    "name": "GitHub",
    "url": "https://github.com",
    "image_url": "https://camo.metorial.com/igu4hi54high"
  },
  "config": {
    "type": "json",
    "config": {},
    "scopes": [
      "repo",
      "repo"
    ]
  }
}
```

--------------------------------

### Get Instance Details

Source: https://metorial.com/api/instance

Retrieves metadata and configuration details for a specific instance. This endpoint allows you to fetch all information related to an instance, including its ID, status, slug, name, type, associated organization and project, and creation/update timestamps.

```APIDOC
## GET /instance

### Description
Retrieves metadata and configuration details for a specific instance.

### Method
GET

### Endpoint
http://api.metorial.com/instance

### Query Parameters
None

### Request Body
None

### Request Example
```bash
curl -X GET "https://api.metorial.com/instance" \
  -H "Authorization: Bearer metorial_sk_..."
```

### Response
#### Success Response (200)
- **object** (String) - The object type, typically 'organization.instance'.
- **id** (String) - The instance's unique identifier.
- **status** (Enum) - The instance's status (e.g., 'active').
- **slug** (String) - The instance's slug.
- **name** (String) - The instance's name.
- **type** (Enum) - The instance's type (e.g., 'development').
- **organization_id** (String) - The organization's unique identifier.
- **project** (Object) - An object containing details of the associated project.
  - **object** (String) - The project object type, typically 'organization.project'.
  - **id** (String) - The project's unique identifier.
  - **status** (Enum) - The project's status.
  - **slug** (String) - The project's slug.
  - **name** (String) - The project's name.
  - **organization_id** (String) - The organization's unique identifier.
  - **created_at** (Date) - The project's creation date.
  - **updated_at** (Date) - The project's last update date.
- **created_at** (Date) - The instance's creation date.
- **updated_at** (Date) - The instance's last update date.

#### Response Example
```json
{
  "object": "organization.instance",
  "id": "example_id",
  "status": "active",
  "slug": "example_slug",
  "name": "example_name",
  "type": "development",
  "organization_id": "example_organization_id",
  "project": {
    "object": "organization.project",
    "id": "example_id",
    "status": "active",
    "slug": "example_slug",
    "name": "example_name",
    "organization_id": "example_organization_id",
    "created_at": "2025-10-29T15:49:32.997Z",
    "updated_at": "2025-10-29T15:49:32.997Z"
  },
  "created_at": "2025-10-29T15:49:32.997Z",
  "updated_at": "2025-10-29T15:49:32.997Z"
}
```
```

--------------------------------

### Example Paginated Response

Source: https://metorial.com/api/index

This JSON response illustrates the structure of paginated results, including a list of items and pagination metadata. The 'has_more_after' flag indicates that further results are available.

```json
{
  "items": [
    {
      "id": "ses_0mcsv9nhnxIQdeTerz35SzF"
      // ...
    }
    // ...
  ],
  "pagination": {
    "has_more_after": true,
    "has_more_before": false
  }
}
```

--------------------------------

### List Server Runs (cURL)

Source: https://metorial.com/api/server-config-vault

This cURL command shows how to list all server runs available in the Server Config Vault. It includes the necessary GET request and authorization header.

```curl
curl -X GET "https://api.metorial.com/server-config-vault" \
  -H "Authorization: Bearer metorial_sk_..."
```

--------------------------------

### Create server deployment

Source: https://metorial.com/api/server-deployment

Create a new server deployment using an existing or newly defined server implementation.

```APIDOC
## Create server deployment

### Description
Create a new server deployment using an existing or newly defined server implementation.

### Method
POST

### Endpoint
/server-deployments

### Request Example
```bash
curl -X POST "https://api.metorial.com/server-deployments" \
  -H "Authorization: Bearer metorial_sk_..."
```
```

--------------------------------

### Get Server Version Details

Source: https://metorial.com/api/server-version

Retrieve detailed information for a specific server version. Use this endpoint to get all attributes of a particular server version.

```APIDOC
## Get server version

### Description
Retrieve details for a specific server version.

### Method
GET

### Endpoint
`/servers/:server_id/versions/:server_version_id`

### Parameters
#### Path Parameters
- **server_id** (String) - Required - The unique identifier for the server
- **server_version_id** (String) - Required - The unique identifier for the server_version

### Request Example
```bash
curl -X GET "https://api.metorial.com/servers/ser_Rm4Mnheq2bfEPhBhP7SY/versions/ser_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."
```

### Response
#### Success Response (200)
(Response structure not detailed in provided text, but would typically include a single server version object)

#### Response Example
```json
{
  "object": "server.server_version",
  "source": {
    "type": "docker",
    "docker": {}
  },
  "schema": {},
  "server": {
    "object": "server#preview",
    "type": "public"
  }
}
```
```

--------------------------------

### Create Server Implementation (cURL)

Source: https://metorial.com/api/server-implementation

Illustrates the process of creating a new server implementation via cURL. This POST request requires a JSON request body containing parameters such as name, description, metadata, launch parameters, server ID, and server variant ID. Authentication is mandatory.

```cURL
curl -X POST "https://api.metorial.com/server-implementations" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{ 
  "name": "example_name",
  "description": "example_description",
  "metadata": "example_metadata",
  "get_launch_params": "example_get_launch_params",
  "server_id": "example_server_id"
}'
```

--------------------------------

### Create magic MCP server

Source: https://metorial.com/api/magic-mcp-server

Create a new magic MCP server.

```APIDOC
## Create magic MCP server

### Description
Create a new magic MCP server.

### Method
POST

### Endpoint
http://api.metorial.com/magic-mcp-servers

### Parameters
#### Request Body
(Request body schema not detailed in the provided text)

### Request Example
```curl
curl -X POST "https://api.metorial.com/magic-mcp-servers" \
  -H "Authorization: Bearer metorial_sk_..."
```

### Response
#### Success Response (200)
(Response structure not detailed in the provided text)
```

--------------------------------

### Get Server Run by ID (cURL)

Source: https://metorial.com/api/server-config-vault

This cURL command demonstrates how to retrieve information for a specific server run using its unique identifier. It utilizes a GET request with the server's ID in the URL.

```curl
curl -X GET "https://api.metorial.com/server-config-vault/ser_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."
```

--------------------------------

### Create Server Deployment (cURL)

Source: https://metorial.com/api/server-deployment

This cURL command initiates the creation of a new server deployment. It requires an existing or newly defined server implementation.

```curl
curl -X POST "https://api.metorial.com/server-deployments" \
  -H "Authorization: Bearer metorial_sk_..."
```

--------------------------------

### Get Session

Source: https://metorial.com/api/session

Retrieves detailed information about a specific session using its unique identifier.

```APIDOC
## Get session

Get the information of a specific session

### Method
GET

### Endpoint
/sessions/:session_id

### Path Parameters
- **session_id** (String) - Required - The unique identifier for the session.

### Request Example
```bash
curl -X GET "https://api.metorial.com/sessions/ses_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."
```

### Response
#### Success Response (200)
- **object** (String) - Type of the returned object, e.g., "session".
- **status** (String) - The status of the session, e.g., "active".
- **connection_status** (String) - The connection status of the session, e.g., "connected".
- **client_secret** (Object) - Details about the client secret.
- **server_deployments** (Array) - List of server deployments linked to the session.
- **usage** (Object) - Usage statistics for the session.
- **metadata** (Object) - Additional metadata for the session.

#### Response Example
```json
{
  "object": "session",
  "status": "active",
  "connection_status": "connected",
  "client_secret": {
    "object": "client_secret",
    "type": "session"
  },
  "server_deployments": [
    {
      "object": "session.server_deployment#preview",
      "metadata": {},
      "server": {
        "object": "server#preview",
        "type": "public"
      },
      "connection_urls": {}
    }
  ],
  "usage": {},
  "metadata": {}
}
```
```

--------------------------------

### Create Server Implementation

Source: https://metorial.com/api/server-implementation

Creates a new server implementation, allowing customization for a specific server or server variant.

```APIDOC
## Create server implementation

### Description
Create a new server implementation for a specific server or server variant.

### Method
POST

### Endpoint
http://api.metorial.com/server-implementations

### Parameters
#### Request Body
- **name** (String) - Optional - The name of the server implementation.
- **description** (String) - Optional - A description for the server implementation.
- **metadata** (String) - Optional - Metadata for the implementation.
- **get_launch_params** (String) - Optional - Parameters for launching the server.
- **server_id** (String) - Required - The ID of the server to associate with this implementation.
- **server_variant_id** (String) - Required - The ID of the server variant to associate with this implementation.

### Request Example
```json
{
  "name": "example_name",
  "description": "example_description",
  "metadata": "example_metadata",
  "get_launch_params": "example_get_launch_params",
  "server_id": "example_server_id",
  "server_variant_id": "example_server_variant_id"
}
```

### Response
#### Success Response (200 or 201)
- **object** (String) - The object type, e.g., "server.server_implementation".
- **status** (String) - The current status of the implementation (e.g., "active").
- **metadata** (Object) - Additional metadata associated with the implementation.
- **server_variant** (Object) - Information about the server variant used.
- **server** (Object) - Information about the base server.

#### Response Example
```json
{
  "object": "server.server_implementation",
  "status": "active",
  "metadata": {},
  "server_variant": {
    "object": "server.server_variant#preview",
    "source": {
      "type": "docker",
      "docker": {}
    }
  },
  "server": {
    "object": "server#preview",
    "type": "public"
  }
}
```
```

--------------------------------

### Get Session Connection

Source: https://metorial.com/api/session-connection

Retrieves detailed information about a specific session connection.

```APIDOC
## Get session connection

### Description
Get the information of a specific session connection using its ID and the session ID.

### Method
GET

### Endpoint
`http://api.metorial.com/sessions/:session_id/connections/:session_connection_id`

### Parameters
#### Path Parameters
- **session_id** (String) - Required - The unique identifier for the session.
- **session_connection_id** (String) - Required - The unique identifier for the session connection.

### Request Example
```curl
curl -X GET "https://api.metorial.com/sessions/ses_Rm4Mnheq2bfEPhBhP7SY/connections/ses_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."
```

### Response
#### Success Response (200)
- **object** (String) - Indicates the type of object, e.g., `session.session_connection`.
- **status** (String) - The current status of the session connection (e.g., `active`).
- **mcp** (Object) - Details about the MCP connection.
- **usage** (Object) - Usage statistics for the connection.
- **server** (Object) - Information about the server.
- **session** (Object) - Information about the associated session.
- **server_deployment** (Object) - Details about the server deployment.

#### Response Example
```json
{
  "object": "session.session_connection",
  "status": "active",
  "mcp": {
    "object": "mcp",
    "connection_type": "sse",
    "client": {
      "object": "session.session_connection.client",
      "capabilities": {}
    },
    "server": {
      "object": "session.session_connection.server",
      "capabilities": {}
    }
  },
  "usage": {},
  "server": {
    "object": "server#preview",
    "type": "public"
  },
  "session": {
    "object": "session#preview",
    "status": "active",
    "connection_status": "connected",
    "usage": {},
    "metadata": {}
  },
  "server_deployment": {
    "object": "server.server_deployment#preview",
    "metadata": {},
    "server": {
      "object": "server#preview",
      "type": "public"
    }
  }
}
```
```

--------------------------------

### Get Server by ID

Source: https://metorial.com/api/servers

Retrieves detailed information for a server identified by its unique ID.

```APIDOC
## GET /servers/:server_id

### Description
Retrieves detailed information for a server identified by its ID.

### Method
GET

### Endpoint
http://api.metorial.com/servers/:server_id

### Parameters
#### Path Parameters
- **server_id** (String) - Required - The unique identifier for the server

### Request Example
```curl
curl -X GET "https://api.metorial.com/servers/ser_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."
```

### Response
#### Success Response (200)
- **object** (String) - The type of the object, which is 'server'.
- **id** (String) - The unique identifier for the server.
- **type** (Enum) - The visibility type of the server; currently only 'public' is supported.
- **status** (Enum) - The current status of the server.
- **name** (String) - The display name of the server.
- **description** (StringNullable) - An optional description providing more details about the server.
- **imported_server_id** (StringNullable) - ID of the server this one was imported from, if applicable.
- **variants** (Object) - A list of available variants for this server.
- **metadata** (Object) - Arbitrary key-value metadata associated with the server.
- **created_at** (Date) - Timestamp when the server was created.
- **updated_at** (Date) - Timestamp when the server was last updated.

#### Response Example
```json
{
  "object": "server",
  "id": "example_id",
  "type": "public",
  "status": "active",
  "name": "example_name",
  "description": "example_description",
  "imported_server_id": "example_imported_server_id",
  "variants": [
    {
      "object": "server.server_variant",
      "status": "active",
      "server": {
        "object": "server#preview",
        "type": "public"
      },
      "current_version": {
        "object": "server.server_version",
        "source": {
          "type": "docker",
          "docker": {}
        },
        "schema": {},
        "server": {
          "object": "server#preview",
          "type": "public"
        }
      },
      "source": {
        "type": "docker",
        "docker": {}
      }
    },
    {
      "object": "server.server_variant",
      "status": "active",
      "server": {
        "object": "server#preview",
        "type": "public"
      },
      "current_version": {
        "object": "server.server_version",
        "source": {
          "type": "docker",
          "docker": {}
        },
        "schema": {},
        "server": {
          "object": "server#preview",
          "type": "public"
        }
      },
      "source": {
        "type": "docker",
        "docker": {}
      }
    }
  ],
  "metadata": {},
  "created_at": "2025-10-29T15:49:33.384Z",
  "updated_at": "2025-10-29T15:49:33.384Z"
}
```
```

--------------------------------

### List server deployments

Source: https://metorial.com/api/server-deployment

Retrieve a list of server deployments within the instance. Supports filtering by status, server, variant, and session.

```APIDOC
## List server deployments

### Description
Retrieve a list of server deployments within the instance. Supports filtering by status, server, variant, and session.

### Method
GET

### Endpoint
/server-deployments

### Parameters
#### Query Parameters
- **limit** (Number) - Optional
- **after** (String) - Optional
- **before** (String) - Optional
- **cursor** (String) - Optional
- **order** (Enum) - Optional
- **status** (Union) - Optional
- **server_id** (Union) - Optional
- **server_variant_id** (Union) - Optional
- **server_implementation_id** (Union) - Optional
- **session_id** (Union) - Optional
- **search** (String) - Optional

### Request Example
```bash
curl -X GET "https://api.metorial.com/server-deployments" \
  -H "Authorization: Bearer metorial_sk_..."
```
```

--------------------------------

### Get callback destination by ID

Source: https://metorial.com/api/callback-destinations

Retrieves details for a specific callback destination by its ID.

```APIDOC
## Get callback destination by ID

### Description
Retrieves details for a specific callback destination by its ID.

### Method
GET

### Endpoint
/callbacks-destinations/:destination_id

### Parameters
#### Path Parameters
- **destination_id** (String) - Required - The unique identifier for the destination.

### Request Example
```bash
curl -X GET "https://api.metorial.com/callbacks-destinations/des_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."
```

### Response
#### Success Response (200)
- **object** (string) - The type of the object, "callback.destination".
- **id** (string) - The unique identifier for the destination.
- **created_at** (string) - Timestamp of creation.
- **updated_at** (string) - Timestamp of the last update.
- **name** (string) - The name of the callback destination.
- **url** (string) - The URL where the callback will be sent.
- **callbacks** (object) - Configuration for which callbacks to send.

#### Response Example
```json
{
  "object": "callback.destination",
  "id": "des_Rm4Mnheq2bfEPhBhP7SY",
  "created_at": "2023-01-01T12:00:00Z",
  "updated_at": "2023-01-01T12:00:00Z",
  "name": "Example Destination",
  "url": "https://example.com/webhook",
  "callbacks": {
    "type": "all"
  }
}
```
```

--------------------------------

### Get File by ID

Source: https://metorial.com/api/files

Retrieves detailed information about a specific file using its unique identifier.

```APIDOC
## Get file by ID

### Description
Retrieves details for a specific file by its ID.

### Method
GET

### Endpoint
/files/:file_id

### Parameters
#### Path Parameters
- **file_id** (String) - Required - The unique identifier for the file.

### Request Example
```bash
curl -X GET "https://api.metorial.com/files/fil_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."
```

### Response
#### Success Response (200)
- **object** (String) - Type of the object, always "file".
- **status** (String) - The status of the file (e.g., "active").
- **file_name** (String) - The name of the file.
- **file_size** (Number) - The size of the file in bytes.
- **file_type** (String) - The MIME type of the file.
- **title** (String) - A user-defined title for the file.
- **purpose** (Object) - Information about the file's purpose.
  - **name** (String) - The name of the purpose.
  - **identifier** (String) - The unique identifier for the purpose.

#### Response Example
```json
{
  "object": "file",
  "status": "active",
  "file_name": "sample.png",
  "file_size": 123456,
  "file_type": "image/png",
  "title": "Sample Image",
  "purpose": {
    "name": "User Image",
    "identifier": "files_image"
  }
}
```
```

--------------------------------

### Get Secret by ID

Source: https://metorial.com/api/secrets

Retrieves detailed information about a specific secret using its unique identifier.

```APIDOC
## Get secret by ID

### Description
Retrieves detailed information about a specific secret by ID.

### Method
GET

### Endpoint
/secrets/:secret_id

### Path Parameters
- **secret_id** (String) - Required - The unique identifier for the secret.

### Request Example
```bash
curl -X GET "https://api.metorial.com/secrets/sec_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."
```

### Response
#### Success Response (200)
- **object** (String) - The type of the object, should be 'secret'.
- **status** (String) - The current status of the secret (e.g., 'active').
- **type** (Object) - An object describing the type of the secret.
- **description** (String) - A description of the secret.
- **metadata** (Object) - Metadata associated with the secret.
- **fingerprint** (String) - A unique fingerprint for the secret.

#### Response Example
```json
{
  "object": "secret",
  "status": "active",
  "type": {},
  "description": "This is a secret",
  "metadata": {},
  "fingerprint": "1234567890abcdef"
}
```
```

--------------------------------

### List Server Implementations (cURL)

Source: https://metorial.com/api/server-implementation

Demonstrates how to retrieve a list of all server implementations using cURL. This request supports filtering by status, server ID, or server variant ID. Ensure you include the Authorization header with your API key for authentication.

```cURL
curl -X GET "https://api.metorial.com/server-implementations" \
  -H "Authorization: Bearer metorial_sk_..."
```

--------------------------------

### Get team

Source: https://metorial.com/api/organization-team

Retrieves the information for a specific organization team using its unique identifier.

```APIDOC
## Get team

### Description
Get the information of a specific team.

### Method
GET

### Endpoint
http://api.metorial.com/organization/teams/:team_id

### Path Parameters
- **team_id** (String) - Required - The unique identifier for the team.

### Request Example
```bash
curl -X GET "https://api.metorial.com/organization/teams/tea_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."
```

### Response
#### Success Response (200)
- **team** (Object) - The organization team object.

#### Response Example
```json
{
  "object": "management.team",
  "projects": [
    {
      "project": {
        "object": "organization.project",
        "status": "active"
      },
      "roles": [
        {
          "role": {
            "object": "management.team.role"
          }
        },
        {
          "role": {
            "object": "management.team.role"
          }
        }
      ]
    }
  ]
}
```
```

--------------------------------

### Server Deployment Object Structure (JSON)

Source: https://metorial.com/api/server-deployment

This JSON object defines the structure and properties of a server deployment, including its status, OAuth connection details, callback configurations, server information, and access control settings.

```json
{
  "object": "server.server_deployment",
  "status": "active",
  "oauth_connection": {
    "object": "provider_oauth.connection",
    "status": "active",
    "metadata": {},
    "provider": {
      "name": "GitHub",
      "url": "https://github.com",
      "image_url": "https://camo.metorial.com/igu4hi54high"
    },
    "config": {
      "type": "json",
      "config": {},
      "scopes": [
        "repo",
        "repo"
      ]
    }
  },
  "callback": {
    "object": "callback",
    "type": "webhook_managed",
    "schedule": {
      "object": "callback.schedule"
    }
  },
  "result": {
    "status": "active"
  },
  "metadata": {},
  "server": {
    "object": "server#preview",
    "type": "public"
  },
  "config": {
    "object": "server.server_deployment.config",
    "status": "active"
  },
  "server_implementation": {
    "object": "server.server_implementation",
    "status": "active",
    "metadata": {},
    "server_variant": {
      "object": "server.server_variant#preview",
      "source": {
        "type": "docker",
        "docker": {}
      }
    },
    "server": {
      "object": "server#preview",
      "type": "public"
    }
  },
  "access": {
    "ip_allowlist": {
      "status": "enabled"
    }
  }
}
```

--------------------------------

### Get Session Message

Source: https://metorial.com/api/session-message

Retrieves the details of a specific session message within a given session.

```APIDOC
## GET /sessions/:session_id/messages/:session_message_id

### Description
Get details of a specific session message.

### Method
GET

### Endpoint
`http://api.metorial.com/sessions/:session_id/messages/:session_message_id`

### Parameters
#### Path Parameters
- **session_id** (String) - Required - The unique identifier for the session
- **session_message_id** (String) - Required - The unique identifier for the session message

### Request Example
```bash
curl -X GET "https://api.metorial.com/sessions/ses_Rm4Mnheq2bfEPhBhP7SY/messages/ses_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."
```

### Response
#### Success Response (200)
- **object** (String) - Type of the object, expected to be 'session.message'
- **type** (String) - Type of the message, e.g., 'request'
- **sender** (Object) - Information about the message sender
  - **object** (String) - Type of the sender object, expected to be 'session.message.sender'
  - **type** (String) - Type of the sender, e.g., 'client'
- **mcp_message** (Object) - The MCP message payload
  - **object** (String) - Type of the MCP message object, expected to be 'session.message.mcp_message'
  - **payload** (Object) - The actual message payload

#### Response Example
```json
{
  "object": "session.message",
  "type": "request",
  "sender": {
    "object": "session.message.sender",
    "type": "client"
  },
  "mcp_message": {
    "object": "session.message.mcp_message",
    "payload": {}
  }
}
```
```

--------------------------------

### List Server Implementations

Source: https://metorial.com/api/server-implementation

Retrieves a list of all server implementations. Supports filtering by status, server, or variant.

```APIDOC
## List server implementations

### Description
Retrieve all server implementations in the instance. Supports filtering by status, server, or variant.

### Method
GET

### Endpoint
http://api.metorial.com/server-implementations

### Parameters
#### Query Parameters
- **limit** (Number) - Optional - Maximum number of results to return.
- **after** (String) - Optional - Cursor for pagination, points to the end of the current page.
- **before** (String) - Optional - Cursor for pagination, points to the start of the current page.
- **cursor** (String) - Optional - A unique identifier for a specific point in the results, used for pagination.
- **order** (Enum) - Optional - Specifies the order of the results. Possible values: `asc`, `desc`.
- **status** (Union) - Optional - Filters implementations by their status. Possible values depend on the system.
- **server_id** (Union) - Optional - Filters implementations by the associated server ID. Possible values depend on the system.
- **server_variant_id** (Union) - Optional - Filters implementations by the associated server variant ID. Possible values depend on the system.
- **search** (String) - Optional - A search term to filter implementations by name or description.

### Response
#### Success Response (200)
- **items** (Object) - An object containing server implementation details.

#### Response Example
```json
{
  "object": "server.server_implementation",
  "status": "active",
  "metadata": {},
  "server_variant": {
    "object": "server.server_variant#preview",
    "source": {
      "type": "docker",
      "docker": {}
    }
  },
  "server": {
    "object": "server#preview",
    "type": "public"
  }
}
```
```

--------------------------------

### Create Organization Team (cURL)

Source: https://metorial.com/api/organization-team

This cURL command demonstrates the process of creating a new organization team. It requires a JSON payload containing the team's name and an optional description, along with an authorization header.

```bash
curl -X POST "https://api.metorial.com/organization/teams" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "name": "example_name",
  "description": "example_description"
}'
```

--------------------------------

### Get Server Config Vault

Source: https://metorial.com/api/server-config-vault

Retrieves the information of a specific server config vault by its ID.

```APIDOC
## Get Server Config Vault

### Description
Retrieves the information of a specific server config vault by its ID.

### Method
GET

### Endpoint
http://api.metorial.com/server-config-vault/:server_config_vault_id

### Path Parameters
- **server_config_vault_id** (String) - Required - The unique identifier for the server_config_vault.

### Request Example
```bash
curl -X GET "https://api.metorial.com/server-config-vault/ser_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."
```

### Response
#### Success Response (200)
- **object** (String) - Type of the object, 'server_config_vault'.
- **id** (String) - Unique identifier for the server config vault.
- **name** (String) - Name of the server config vault.
- **description** (String) - Description of the server config vault.
- **config** (String) - The configuration data.
- **created_at** (String) - Timestamp of creation.

#### Response Example
```json
{
  "object": "server_config_vault",
  "id": "ser_Rm4Mnheq2bfEPhBhP7SY",
  "name": "Example Vault",
  "description": "Configuration for example service",
  "config": "{\"key\": \"value\"}",
  "created_at": "2023-10-26T10:00:00Z"
}
```
```

--------------------------------

### Get magic MCP server

Source: https://metorial.com/api/magic-mcp-server

Retrieve the information of a specific magic MCP server by its ID.

```APIDOC
## Get magic MCP server

### Description
Get the information of a specific magic MCP server by its unique identifier.

### Method
GET

### Endpoint
http://api.metorial.com/magic-mcp-servers/:magic_mcp_server_id

### Parameters
#### Path Parameters
- **magic_mcp_server_id** (String) - Required - The unique identifier for the magic_mcp_server.

### Request Example
```curl
curl -X GET "https://api.metorial.com/magic-mcp-servers/mag_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."
```

### Response
#### Success Response (200)
(Response structure not detailed in the provided text)
```

--------------------------------

### List magic MCP server

Source: https://metorial.com/api/magic-mcp-server

List all magic MCP servers with optional filtering and pagination.

```APIDOC
## List magic MCP server

### Description
List all magic MCP servers with optional filtering and pagination.

### Method
GET

### Endpoint
http://api.metorial.com/magic-mcp-servers

### Parameters
#### Query Parameters
- **limit** (Number) - Optional - Maximum number of results to return.
- **after** (String) - Optional - Cursor for fetching results after a specific item.
- **before** (String) - Optional - Cursor for fetching results before a specific item.
- **cursor** (String) - Optional - The cursor to use for pagination.
- **order** (Enum) - Optional - The order of the results (e.g., 'asc', 'desc').
- **status** (Union) - Optional - Filter by server status.
- **server_id** (Union) - Optional - Filter by server ID.
- **server_variant_id** (Union) - Optional - Filter by server variant ID.
- **server_implementation_id** (Union) - Optional - Filter by server implementation ID.
- **session_id** (Union) - Optional - Filter by session ID.
- **search** (String) - Optional - Search term for filtering servers.

### Request Example
```curl
curl -X GET "https://api.metorial.com/magic-mcp-servers" \
  -H "Authorization: Bearer metorial_sk_..."
```

### Response
#### Success Response (200)
(Response structure not detailed in the provided text)
```
Tokens:
Raw