Sign in
workspace

Get Resource

Gets the metadata of a resource by ID.

get/v1/workspace/resources/{resource_id}

Path parameters

resource_idstring required

The ID of the target resource.

The ID of the target resource.

Query parameters

resource_type'voice' | 'voice_collection' | 'pronunciation_dictionary' | 'dubbing' | 'project' | 'convai_agents' | 'convai_knowledge_base_documents' | 'convai_tools' | 'convai_settings' | 'convai_secrets' | 'workspace_auth_connections' | 'convai_phone_numbers' | 'convai_mcp_servers' | 'convai_api_integration_connections' | 'convai_api_integration_trigger_connections' | 'convai_batch_calls' | 'convai_agent_response_tests' | 'convai_test_suite_invocations' | 'convai_crawl_jobs' | 'convai_crawl_tasks' | 'convai_kb_external_sync_jobs' | 'convai_whatsapp_accounts' | 'convai_agent_versions' | 'convai_agent_branches' | 'convai_agent_versions_deployments' | 'convai_agent_experiments' | 'convai_memory_entries' | 'convai_coaching_proposals' | 'convai_templates' | 'dashboard' | 'dashboard_configuration' | 'convai_agent_drafts' | 'resource_locators' | 'assets' | 'content_generations' | 'content_templates' | 'content_skills' | 'songs' | 'transcription_tasks' | 'avatars' | 'avatar_video_generations' | 'resource_collection' | 'studio_projects' | 'convai_analysis_items' required

Resource types that can be shared in the workspace. The name always need to match the collection names

Resource type of the target resource.

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

resource_idstring required

The ID of the resource.

resource_namestring nullable required

The name of the resource, if available.

resource_type'voice' | 'voice_collection' | 'pronunciation_dictionary' | 'dubbing' | 'project' | 'convai_agents' | 'convai_knowledge_base_documents' | 'convai_tools' | 'convai_settings' | 'convai_secrets' | 'workspace_auth_connections' | 'convai_phone_numbers' | 'convai_mcp_servers' | 'convai_api_integration_connections' | 'convai_api_integration_trigger_connections' | 'convai_batch_calls' | 'convai_agent_response_tests' | 'convai_test_suite_invocations' | 'convai_crawl_jobs' | 'convai_crawl_tasks' | 'convai_kb_external_sync_jobs' | 'convai_whatsapp_accounts' | 'convai_agent_versions' | 'convai_agent_branches' | 'convai_agent_versions_deployments' | 'convai_agent_experiments' | 'convai_memory_entries' | 'convai_coaching_proposals' | 'convai_templates' | 'dashboard' | 'dashboard_configuration' | 'convai_agent_drafts' | 'resource_locators' | 'assets' | 'content_generations' | 'content_templates' | 'content_skills' | 'songs' | 'transcription_tasks' | 'avatars' | 'avatar_video_generations' | 'resource_collection' | 'studio_projects' | 'convai_analysis_items' required

Resource types that can be shared in the workspace. The name always need to match the collection names

creator_user_idstring nullable required

The ID of the user who created the resource.

anonymous_access_level_override'admin' | 'editor' | 'commenter' | 'viewer' nullable required

The access level for anonymous users. If None, the resource is not shared publicly.

role_to_group_idsobject required

A mapping of grant slots to group IDs. Keys are the preset access roles plus workspace custom-role ids ('role_...'). When the resource is shared with a user, the group id is the user's id.

Example response

{
  "anonymous_access_level_override": "viewer",
  "creator_user_id": "5zavrE1kZXv2lFw9BKgEkf0B5Wqo",
  "resource_id": "4ZUqyldxf71HqUbcP2Lc",
  "resource_name": "My Custom Voice",
  "resource_type": "voice",
  "role_to_group_ids": {
    "admin": [
      "5zavrE1kZXv2lFw9BKgEkf0B5Wqo"
    ],
    "editor": [
      "8ruQDGM2R4w1mFbHI5aROCUjIpJZ"
    ],
    "role_01jd7yq2k8f0abcd1234wxyz": [
      "9mQrTx4vNb2wKpLs6ZyE1cHgUdFa"
    ],
    "viewer": []
  },
  "share_options": [
    {
      "id": "i2YYI6huwBmcgYydAXARmQJc3pmX",
      "name": "user@example.com",
      "type": "user"
    },
    {
      "id": "x1AfvYKAmiqxCnbvZeNXHqqthJaC",
      "name": "mygroup",
      "type": "group"
    }
  ]
}

Changes

Changed in 3 of the 30 revisions of this API.133

  • 4bbf59c13c421See the full diff
    • ▲

      removed 'propertyNames' constraint from the response property for the status

      response-property-property-names-removed

  • 6c2d6eb4a7e622See the full diff
    • ●

      added the new content_skills enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new convai_agent_experiments enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      added the new enum value content_skills to the query request parameter resource_type

      request-parameter-enum-value-added

    • ○

      added the new enum value convai_agent_experiments to the query request parameter resource_type

      request-parameter-enum-value-added

  • 494d96419d1511See the full diff
    • ●

      added the new convai_analysis_items enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      added the new enum value convai_analysis_items to the query request parameter resource_type

      request-parameter-enum-value-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog