Sign in

v5

OpenAPI 3.1.02026-08-043621,4011.8 MB
audio-native

Get Audio Native Project Settings

Get player settings for the specific project.

get/v1/audio-native/{project_id}/settings

Path parameters

project_idstring required

The ID of the Studio project.

Example:21m00Tcm4TlvDq8ikWAM

The ID of the Studio project.

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Response

Successful Response

enabledboolean required

Whether the project is enabled.

snapshot_idstring nullable

The ID of the latest snapshot of the project.

Example response

{
  "enabled": true,
  "settings": {
    "audio_path": "audio/my_project.mp3",
    "audio_url": "https://example.com/audio/my_project.mp3",
    "author": "John Doe",
    "background_color": "#FFFFFF",
    "image": "https://example.com/image.jpg",
    "sessionization": 1,
    "small": false,
    "status": "ready",
    "text_color": "#000000",
    "title": "My Project"
  },
  "snapshot_id": "JBFqnCBsd6RMkjVDRZzb"
}