Read a document's status

GET/api/v1/documents/{id}

認証

AuthorizationOAuth2 アクセストークン · header必須

Authorization-code grant with PKCE. Clients are public and hold no secret. Discovery is published at /.well-known/oauth-authorization-server/api/auth.

スコープ:api.access

パスパラメーター

idstring必須

A document's id

最小長 1 · 最大長 255

レスポンス

200

Where the generation has got to

idstring必須

最小長 1 · 最大長 255

inputHashstring必須

outputHashstring | null必須

statusstring必須

許可される値:pendingreadyfailed

400

The request body, query or parameters were refused

codestring必須

許可される値:invalid_inputnot_foundconflictforbidden

detailany

errorstring必須

reasonstring

401

The access token is missing, invalid or revoked

errorstring必須

403

The tenant's module is off, or the token's scope or the member's role does not permit the action

codestring必須

許可される値:invalid_inputnot_foundconflictforbidden

detailany

errorstring必須

reasonstring

404

No such record, or none the caller may read

codestring必須

許可される値:invalid_inputnot_foundconflictforbidden

detailany

errorstring必須

reasonstring

413

The request exceeds the route's body limit

errorstring必須

500

An unexpected failure

errorstring必須

リクエスト

curl -X GET '/api/v1/api/v1/documents/string' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("/api/v1/api/v1/documents/string", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "/api/v1/api/v1/documents/string",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Accept": "application/json"
    },
)

レスポンス

{
  "id": "string",
  "inputHash": "string",
  "outputHash": "string",
  "status": "pending"
}

{
  "code": "invalid_input",
  "detail": null,
  "error": "string",
  "reason": "string"
}

{
  "error": "string"
}

{
  "code": "invalid_input",
  "detail": null,
  "error": "string",
  "reason": "string"
}

{
  "code": "invalid_input",
  "detail": null,
  "error": "string",
  "reason": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}