Skip to main content
GET
Get Resource

Headers

x-api-key
string | null

Your API key for programmatic access. Send it in the x-api-key header; you can create and manage keys from the Developers page.

Path Parameters

resource_id
string
required

The ID of the target resource.

Query Parameters

resource_type
enum<string>
required

Resource type of the target resource.

Available options:
voice,
voice_collection,
pronunciation_dictionary,
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_memory_entries,
convai_coaching_proposals,
convai_templates,
dashboard,
dashboard_configuration,
convai_agent_drafts,
resource_locators,
assets,
transcription_tasks,
avatars,
resource_collection,
convai_analysis_items

Response

Successful Response

resource_id
string
required

The ID of the resource.

resource_name
string | null
required

The name of the resource, if available.

resource_type
enum<string>
required

The type of the resource.

Available options:
voice,
voice_collection,
pronunciation_dictionary,
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_memory_entries,
convai_coaching_proposals,
convai_templates,
dashboard,
dashboard_configuration,
convai_agent_drafts,
resource_locators,
assets,
transcription_tasks,
avatars,
resource_collection,
convai_analysis_items
creator_user_id
string | null
required

The ID of the user who created the resource.

anonymous_access_level_override
enum<string> | null
required

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

Available options:
admin,
editor,
commenter,
viewer
role_to_group_ids
Role To Group Ids · object
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.

share_options
ShareOptionResponseModel · object[]
required

List of options for sharing the resource further in the workspace. These are users who don't have access to the resource yet.