curl --request PUT \
--url https://api.avidoai.com/v0/documents/{id}/assign \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-application-id: <api-key>' \
--data '
{
"userId": "user_123456789"
}
'{
"document": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"createdAt": "2024-01-05T12:34:56.789Z",
"modifiedAt": "2024-01-05T12:34:56.789Z",
"orgId": "org_123456789",
"assignee": "user_123456789",
"optimized": false,
"versions": [
{
"id": "321e4567-e89b-12d3-a456-426614174001",
"createdAt": "2024-01-05T12:34:56.789Z",
"modifiedAt": "2024-01-05T12:34:56.789Z",
"orgId": "org_123456789",
"title": "API Documentation",
"content": "This document describes the API endpoints...",
"metadata": {},
"originalSentences": [
"This is the first sentence.",
"This is the second sentence."
],
"language": "english",
"status": "APPROVED",
"versionNumber": 1,
"documentId": "123e4567-e89b-12d3-a456-426614174000"
}
],
"title": "<string>",
"content": "<string>",
"activeVersionId": "321e4567-e89b-12d3-a456-426614174001",
"scrapeJob": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"createdAt": "2024-01-05T12:34:56.789Z",
"modifiedAt": "2024-01-05T12:34:56.789Z",
"orgId": "org_123",
"initiatedBy": "user_123",
"name": "Documentation Scrape",
"url": "https://example.com",
"status": "PENDING",
"pages": [
{
"url": "https://example.com/page1",
"title": "Page 1",
"description": "This is the first page of the documentation.",
"category": "Documentation"
},
{
"url": "https://example.com/page2"
}
]
},
"scrapeJobId": "321e4567-e89b-12d3-a456-426614174000"
}
}Assigns a specific document to a user by their user ID.
curl --request PUT \
--url https://api.avidoai.com/v0/documents/{id}/assign \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-application-id: <api-key>' \
--data '
{
"userId": "user_123456789"
}
'{
"document": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"createdAt": "2024-01-05T12:34:56.789Z",
"modifiedAt": "2024-01-05T12:34:56.789Z",
"orgId": "org_123456789",
"assignee": "user_123456789",
"optimized": false,
"versions": [
{
"id": "321e4567-e89b-12d3-a456-426614174001",
"createdAt": "2024-01-05T12:34:56.789Z",
"modifiedAt": "2024-01-05T12:34:56.789Z",
"orgId": "org_123456789",
"title": "API Documentation",
"content": "This document describes the API endpoints...",
"metadata": {},
"originalSentences": [
"This is the first sentence.",
"This is the second sentence."
],
"language": "english",
"status": "APPROVED",
"versionNumber": 1,
"documentId": "123e4567-e89b-12d3-a456-426614174000"
}
],
"title": "<string>",
"content": "<string>",
"activeVersionId": "321e4567-e89b-12d3-a456-426614174001",
"scrapeJob": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"createdAt": "2024-01-05T12:34:56.789Z",
"modifiedAt": "2024-01-05T12:34:56.789Z",
"orgId": "org_123",
"initiatedBy": "user_123",
"name": "Documentation Scrape",
"url": "https://example.com",
"status": "PENDING",
"pages": [
{
"url": "https://example.com/page1",
"title": "Page 1",
"description": "This is the first page of the documentation.",
"category": "Documentation"
},
{
"url": "https://example.com/page2"
}
]
},
"scrapeJobId": "321e4567-e89b-12d3-a456-426614174000"
}
}Your unique Avido API key
Your unique Avido Application ID
The unique identifier of the document
"123e4567-e89b-12d3-a456-426614174000"
Request body for assigning a document to a user
The unique identifier of the user to assign the document to
"user_123456789"
Document assigned successfully
Successful response containing the document data
Show child attributes