Tasks
Get Task
Retrieves the data for a specific task by its ID.
x-api-key
<token>
API Key for authentication
In: header
Path Parameters
idrequired
string
The id of the task to get.
Response Body
curl -X GET "https://api.scan-documents.com/v1/tasks/task_euyrvozb9302uwhq"fetch("https://api.scan-documents.com/v1/tasks/task_euyrvozb9302uwhq")package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https://api.scan-documents.com/v1/tasks/task_euyrvozb9302uwhq"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}import requests
url = "https://api.scan-documents.com/v1/tasks/task_euyrvozb9302uwhq"
response = requests.request("GET", url)
print(response.text)import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;
import java.time.Duration;
HttpClient client = HttpClient.newBuilder()
.connectTimeout(Duration.ofSeconds(10))
.build();
HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
.uri(URI.create("https://api.scan-documents.com/v1/tasks/task_euyrvozb9302uwhq"))
.GET()
.build();
try {
HttpResponse<String> response = client.send(requestBuilder.build(), BodyHandlers.ofString());
System.out.println("Status code: " + response.statusCode());
System.out.println("Response body: " + response.body());
} catch (Exception e) {
e.printStackTrace();
}using System;
using System.Net.Http;
using System.Text;
var client = new HttpClient();
var response = await client.GetAsync("https://api.scan-documents.com/v1/tasks/task_euyrvozb9302uwhq");
var responseBody = await response.Content.ReadAsStringAsync();{
"id": "task_euyrvozb9302uwhq",
"operation": "apply-effect",
"parameters": {
"input": "file_avyrvozb9302uwhq",
"name": "Example Image",
"effect": "grayscale",
"callback_url": "https://example.com/callback"
},
"status": "completed",
"result": {
"generated_files": [
{
"id": "file_euyrvozb9302uwhq",
"name": "Example Image",
"type": "image/png",
"properties": {
"size": 1024,
"width": 800,
"height": 600
},
"task_id": "task_euyrvozb9302uwhq",
"created_at": "2021-05-01T12:00:00Z"
}
]
},
"callback_url": "https://example.com/callback",
"created_at": "2021-05-01T12:00:00Z",
"updated_at": "2021-05-01T12:00:00Z"
}{
"type": "https://scan-documents.com/docs/errors/not-found",
"title": "Not Found",
"status": 404,
"message": "{resource} with id {id} not found."
}{
"type": "https://scan-documents.com/docs/errors/validation-error",
"title": "Validation Error",
"status": 422,
"errors": {
"{field}": [
"{error}."
]
}
}{
"type": "https://scan-documents.com/docs/errors/rate-limit-error",
"title": "Rate Limit Exceeded",
"status": 429,
"message": "Rate limit exceeded. Please try again later or contact support."
}{
"type": "https://scan-documents.com/docs/errors/internal-error",
"title": "An unexpected error occurred. Contact support if the problem persists.",
"status": 500,
"message": "An unexpected error occurred. Contact support if the problem persists."
}