Release Notes
- What's new
- Known issues
- Troubleshooting
- License reference
Get Started
Environments
Connections
Tools
Large Language Models (LLMs)
Evaluation Framework
Webchats
Tutorials
API's reference
- watsonx Orchestrate Developer Edition APIs
- Orchestrate Agent
- Assistants Runs
- Custom Assistants
- watsonx Assistant
- External Chat Agents
- Message Threads
- Documents
- Vector Index
- Catalog Management
- Tenant Management
- Provisioning Lite
- Embed settings
- User Profiles
- Completions
- Background Tasks
- Auth
- Orchestrate Assistant
- Notifications
- IBM unique ID mapping
- Prompts
- Artifact Management
- Default Agent Settings
- all journey types
- Connections
- Tools
- Welcome Content
- LLM Analytics
- Internal Calls are listed over here
- Agents
- Agent Releases
- Agent Release Environments
- Agent Chat Starter Settings
- API Reference
- channel integration
- Knowledge-Bases
- Chat with Docs
- Toolkits
- Voice Configurations
- Models
- Model-Policy
- Credentials
- Teams Channel
- Twilio WhatsApp Channel
Legal notices
Documents
Upload Document
POST
/
documents
/
{doc_id}
/
upload
Copy
Ask AI
curl --request POST \
--url http://localhost/api/v1/documents/{doc_id}/upload \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data'
Copy
Ask AI
{
"task_id": "<string>",
"task_name": "<string>",
"status": "unknown",
"task_args": {},
"result": "<string>"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Query Parameters
Available options:
auto
, fast
, hi_res
, ocr_only
Body
multipart/form-data
Response
200
application/json
Successful Response
The response is of type object
.
Copy
Ask AI
curl --request POST \
--url http://localhost/api/v1/documents/{doc_id}/upload \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data'
Copy
Ask AI
{
"task_id": "<string>",
"task_name": "<string>",
"status": "unknown",
"task_args": {},
"result": "<string>"
}
Assistant
Responses are generated using AI and may contain mistakes.