Projects

The /projects endpoint allows you to manage your Projects.

Retrieve a Project

Endpoint: /projects/<PROJECT_ID>

Method: GET

Headers

Header	Value
`Authorization`	`Bearer <YOUR_JWT_TOKEN>`

Path Parameters

Parameter	Data Type	Description
PROJECT_ID	string	The ID of the Project to retrieve.

Example Request

curl --location --request GET 'https://studio-server-production.api.vertesia.io/api/v1/projects/<PROJECT_ID>' \
--header 'Authorization: Bearer <YOUR_JWT_TOKEN>'

Example Response

{
  "id": "<PROJECT_ID>",
  "name": "My Project",
  "namespace": "my-project",
  "description": "This is my project.",
  "account": "<ACCOUNT_ID>",
  "configuration": {
    "human_context": "You are a helpful AI assistant.",
    "default_environment": "<ENVIRONMENT_ID>",
    "default_model": "gpt-3.5-turbo",
    "embeddings": {
        "text": {
            "environment": "<ENVIRONMENT_ID>",
            "enabled": true,
            "dimensions": 1536
        }
    }
  },
  "integrations": {},
  "created_by": "user:<USER_ID>",
  "updated_by": "user:<USER_ID>",
  "created_at": "2023-07-19T13:54:12.854Z",
  "updated_at": "2023-07-19T13:54:12.854Z"
}

Code Examples

Retrieve a Project

curl --location --request GET 'https://studio-server-production.api.vertesia.io/api/v1/projects/<PROJECT_ID>' \
--header 'Authorization: Bearer <YOUR_JWT_TOKEN>'

List Projects

Endpoint: /projects

Method: GET

Headers

Header	Value
`Authorization`	`Bearer <YOUR_JWT_TOKEN>`

Query Parameters

Parameter	Data Type	Description
account	string[]	An optional list of Account IDs to filter by.

Example Request

curl --location --request GET 'https://studio-server-production.api.vertesia.io/api/v1/projects' \
--header 'Authorization: Bearer <YOUR_JWT_TOKEN>'

Example Response

[
  {
    "id": "<PROJECT_ID>",
    "name": "My Project",
    "account": "<ACCOUNT_ID>"
  }
]

Code Examples

List all Projects

curl --location --request GET 'https://studio-server-production.api.vertesia.io/api/v1/projects' \
--header 'Authorization: Bearer <YOUR_JWT_TOKEN>'

List Projects for an Account

curl --location --request GET 'https://studio-server-production.api.vertesia.io/api/v1/projects?account=<ACCOUNT_ID>' \
--header 'Authorization: Bearer <YOUR_JWT_TOKEN>'

Create a Project

Endpoint: /projects

Method: POST

Headers

Header	Value
`Authorization`	`Bearer <YOUR_JWT_TOKEN>`

Input Parameters

Parameter	Data Type	Description
name	string	The name of the Project.
namespace	string	The namespace of the Project.
description	string	The description of the Project.

Example Request

curl --location --request POST 'https://studio-server-production.api.vertesia.io/api/v1/projects' \
--header 'Authorization: Bearer <YOUR_JWT_TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "My Project",
    "namespace": "my-project",
    "description": "This is my project."
}'

Example Response

{
  "id": "<PROJECT_ID>",
  "name": "My Project",
  "namespace": "my-project",
  "description": "This is my project.",
  "account": "<ACCOUNT_ID>",
  "configuration": {
    "human_context": "You are a helpful AI assistant.",
    "embeddings": {}
  },
  "integrations": {},
  "created_by": "user:<USER_ID>",
  "updated_by": "user:<USER_ID>",
  "created_at": "2023-07-19T13:54:12.854Z",
  "updated_at": "2023-07-19T13:54:12.854Z"
}

Code Examples

Create a Project

curl --location --request POST 'https://studio-server-production.api.vertesia.io/api/v1/projects' \
--header 'Authorization: Bearer <YOUR_JWT_TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "My Project",
    "namespace": "my-project",
    "description": "This is my project."
}'

Update a Project

Endpoint: /projects/<PROJECT_ID>

Method: PUT

Headers

Header	Value
`Authorization`	`Bearer <YOUR_JWT_TOKEN>`

Path Parameters

Parameter	Data Type	Description
PROJECT_ID	string	The ID of the Project to update.

Input Parameters

Parameter	Data Type	Description
name	string	The name of the Project.
description	string	The description of the Project.
configuration	ProjectConfiguration	The configuration of the Project.

Example Request

curl --location --request PUT 'https://studio-server-production.api.vertesia.io/api/v1/projects/<PROJECT_ID>' \
--header 'Authorization: Bearer <YOUR_JWT_TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "My Updated Project",
    "description": "This is my updated project.",
    "configuration": {
        "human_context": "You are a helpful AI assistant.",
        "default_environment": "<ENVIRONMENT_ID>",
        "default_model": "gpt-3.5-turbo"
    }
}'

Example Response

{
  "id": "<PROJECT_ID>",
  "name": "My Updated Project",
  "namespace": "my-project",
  "description": "This is my updated project.",
  "account": "<ACCOUNT_ID>",
  "configuration": {
    "human_context": "You are a helpful AI assistant.",
    "default_environment": "<ENVIRONMENT_ID>",
    "default_model": "gpt-3.5-turbo",
    "embeddings": {}
  },
  "integrations": {},
  "created_by": "user:<USER_ID>",
  "updated_by": "user:<USER_ID>",
  "created_at": "2023-07-19T13:54:12.854Z",
  "updated_at": "2023-07-19T14:12:34.567Z"
}

Code Examples

Update a Project

curl --location --request PUT 'https://studio-server-production.api.vertesia.io/api/v1/projects/<PROJECT_ID>' \
--header 'Authorization: Bearer <YOUR_JWT_TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "My Updated Project",
    "description": "This is my updated project.",
    "configuration": {
        "human_context": "You are a helpful AI assistant.",
        "default_environment": "<ENVIRONMENT_ID>",
        "default_model": "gpt-3.5-turbo"
    }
}'

List Project Integrations

Endpoint: /projects/<PROJECT_ID>/integrations

Method: GET

Headers

Header	Value
`Authorization`	`Bearer <YOUR_JWT_TOKEN>`

Path Parameters

Parameter	Data Type	Description
PROJECT_ID	string	The ID of the Project to retrieve Integrations for.

Example Request

curl --location --request GET 'https://studio-server-production.api.vertesia.io/api/v1/projects/<PROJECT_ID>/integrations' \
--header 'Authorization: Bearer <YOUR_JWT_TOKEN>'

Example Response

{
  "integrations": [
    {
      "id": "gladia",
      "enabled": false
    },
    {
      "id": "github",
      "enabled": false
    }
  ]
}

Code Examples

List Project Integrations

curl --location --request GET 'https://studio-server-production.api.vertesia.io/api/v1/projects/<PROJECT_ID>/integrations' \
--header 'Authorization: Bearer <YOUR_JWT_TOKEN>'

Retrieve a Project Integration Configuration

Endpoint: /projects/<PROJECT_ID>/integrations/<INTEGRATION_ID>

Method: GET

Headers

Header	Value
`Authorization`	`Bearer <YOUR_JWT_TOKEN>`

Path Parameters

Parameter	Data Type	Description
PROJECT_ID	string	The ID of the Project to retrieve the Integration Configuration for.
INTEGRATION_ID	string	The ID of the Integration to retrieve.

Example Request

curl --location --request GET 'https://studio-server-production.api.vertesia.io/api/v1/projects/<PROJECT_ID>/integrations/gladia' \
--header 'Authorization: Bearer <YOUR_JWT_TOKEN>'

Example Response

{
  "enabled": false,
  "api_key": "sk-...",
  "url": "https://gladia.com"
}

Code Examples

Retrieve a Project Integration Configuration

curl --location --request GET 'https://studio-server-production.api.vertesia.io/api/v1/projects/<PROJECT_ID>/integrations/gladia' \
--header 'Authorization: Bearer <YOUR_JWT_TOKEN>'

Update a Project Integration Configuration

Endpoint: /projects/<PROJECT_ID>/integrations/<INTEGRATION_ID>

Method: PUT

Headers

Header	Value
`Authorization`	`Bearer <YOUR_JWT_TOKEN>`

Path Parameters

Parameter	Data Type	Description
PROJECT_ID	string	The ID of the Project to update the Integration Configuration for.
INTEGRATION_ID	string	The ID of the Integration to update.

Input Parameters

Parameter	Data Type	Description
enabled	boolean	Whether the Integration is enabled.
api_key	string	The API Key for the Integration.
url	string	The URL for the Integration.
allowed_repositories	string[]	The list of allowed repositories for the Integration.

Example Request

curl --location --request PUT 'https://studio-server-production.api.vertesia.io/api/v1/projects/<PROJECT_ID>/integrations/gladia' \
--header 'Authorization: Bearer <YOUR_JWT_TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "enabled": true,
    "api_key": "sk-...",
    "url": "https://gladia.com"
}'

Example Response

{
  "enabled": true,
  "api_key": "sk-...",
  "url": "https://gladia.com"
}

Code Examples

Update a Project Integration Configuration

curl --location --request PUT 'https://studio-server-production.api.vertesia.io/api/v1/projects/<PROJECT_ID>/integrations/gladia' \
--header 'Authorization: Bearer <YOUR_JWT_TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "enabled": true,
    "api_key": "sk-...",
    "url": "https://gladia.com"
}'