Skip to main content
POST
/
v2
/
organizations
/
{organizationId}
/
directories
curl -X POST "https://api.orbitsearch.com/v2/organizations/$ORGANIZATION_ID/directories" \
  -H "Authorization: Bearer $USER_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "Q4 Prospects"}'
{
  "id": "<string>",
  "name": "<string>",
  "type": "<string>",
  "org_id": "<string>"
}
Creates a new standard directory inside the specified organization. Use this to set up an isolated searchable corpus before uploading source data.
Directory search requires an organization API key. Personal API keys cannot search directory corpora. See directory grants for the permission model.

Path parameters

organizationId
string
required
The UUID of the organization that will own the directory.

Request body

name
string
required
A human-readable display name for the directory (for example, "Q4 Prospects").

Response fields

id
string
UUID that uniquely identifies this directory. Use it in all subsequent source, grant, and search requests.
name
string
The display name you provided at creation.
type
string
Directory type. One of standard or connections. The Personal Connections directory is connections; all directories you create are standard.
org_id
string
UUID of the organization that owns this directory.
curl -X POST "https://api.orbitsearch.com/v2/organizations/$ORGANIZATION_ID/directories" \
  -H "Authorization: Bearer $USER_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "Q4 Prospects"}'