Get deep research result
GEThttps://api.vectorize.io/v1/org/:organizationId/pipelines/:pipelineId/deep-research/:researchId
Get deep research result
Request
Path Parameters
organizationId stringrequired
pipelineId stringrequired
researchId stringrequired
Responses
- 200
- 400
- 401
- 403
- 404
- 500
Get Deep Research was successful
- application/json
- Schema
- Example (auto)
- Example
Schema
readybooleanrequired
data object
{
"ready": true,
"data": {
"success": true,
"events": [
"string"
],
"markdown": "string",
"error": "string"
}
}
{
"ready": true,
"data": {
"success": true,
"events": [],
"markdown": "example-markdown",
"error": null
}
}
Invalid request
- application/json
- Schema
- Example (auto)
- Example
Schema
errorstringrequired
detailsstring
failedUpdatesstring[]
successfulUpdatesstring[]
{
"error": "string",
"details": "string",
"failedUpdates": [
"string"
],
"successfulUpdates": [
"string"
]
}
{
"error": "An error occurred",
"details": "example-details",
"failedUpdates": [],
"successfulUpdates": []
}
Unauthorized
- application/json
- Schema
- Example (auto)
- Example
Schema
errorstringrequired
detailsstring
failedUpdatesstring[]
successfulUpdatesstring[]
{
"error": "string",
"details": "string",
"failedUpdates": [
"string"
],
"successfulUpdates": [
"string"
]
}
{
"error": "An error occurred",
"details": "example-details",
"failedUpdates": [],
"successfulUpdates": []
}
Forbidden
- application/json
- Schema
- Example (auto)
- Example
Schema
errorstringrequired
detailsstring
failedUpdatesstring[]
successfulUpdatesstring[]
{
"error": "string",
"details": "string",
"failedUpdates": [
"string"
],
"successfulUpdates": [
"string"
]
}
{
"error": "An error occurred",
"details": "example-details",
"failedUpdates": [],
"successfulUpdates": []
}
Not found
- application/json
- Schema
- Example (auto)
- Example
Schema
errorstringrequired
detailsstring
failedUpdatesstring[]
successfulUpdatesstring[]
{
"error": "string",
"details": "string",
"failedUpdates": [
"string"
],
"successfulUpdates": [
"string"
]
}
{
"error": "An error occurred",
"details": "example-details",
"failedUpdates": [],
"successfulUpdates": []
}
Internal server error
- application/json
- Schema
- Example (auto)
- Example
Schema
errorstringrequired
detailsstring
failedUpdatesstring[]
successfulUpdatesstring[]
{
"error": "string",
"details": "string",
"failedUpdates": [
"string"
],
"successfulUpdates": [
"string"
]
}
{
"error": "An error occurred",
"details": "example-details",
"failedUpdates": [],
"successfulUpdates": []
}
Authorization: http
name: bearerAuthtype: httpscheme: bearerbearerFormat: JWT
- csharp
- curl
- dart
- go
- http
- java
- javascript
- kotlin
- c
- nodejs
- objective-c
- ocaml
- php
- powershell
- python
- r
- ruby
- rust
- shell
- swift
- HTTPCLIENT
- RESTSHARP
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.vectorize.io/v1/org/:organizationId/pipelines/:pipelineId/deep-research/:researchId");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
ResponseClear