Skip to main content
POST
/
v1
/
apps
curl --location --request POST 'https://api.getmetal.io/v1/apps' \
--header 'Content-Type: application/json' \
--header 'x-metal-api-key: <api-key>' \
--header 'x-metal-client-id: <client-id>' \
--data-raw '{
    "name": "Metal App"
    "indexes": ["indexID"]
}'

{
    "data": {
        "id": "6535126922af1b89d6d22ffa",
        "name": "Metal App",
        "indexes": ["indexID"]
    }
}

Documentation Index

Fetch the complete documentation index at: https://docs.getmetal.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Auth Headers

​
x-metal-api-key
string
required
An API key for your org.
​
x-metal-client-id
string
required
A Client ID for your org.

​
Body

​
name
string
required
Name of the App.
​
indexes
array
An array containing the ID of the index you want to connect with the app. This array can have a maximum length of 1.

​
Response

​
data
App Object
curl --location --request POST 'https://api.getmetal.io/v1/apps' \
--header 'Content-Type: application/json' \
--header 'x-metal-api-key: <api-key>' \
--header 'x-metal-client-id: <client-id>' \
--data-raw '{
    "name": "Metal App"
    "indexes": ["indexID"]
}'

{
    "data": {
        "id": "6535126922af1b89d6d22ffa",
        "name": "Metal App",
        "indexes": ["indexID"]
    }
}