Prepare an ingestion job

​

Creates an ingestion job and returns presigned S3 upload URLs for each file

OAuth scopes
  • specs/ingest
Body
required
application/json
  • files
    Type: array object[] 1…
    required

    Files to upload for ingestion

  • githubSlug
    Type: string
    required

    GitHub repository identifier in format org/repo

Responses
  • application/json
Request Example for post/ingestion/v2/prepare
curl https://api.specs.wseng.ai/ingestion/v2/prepare \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "githubSlug": "org/repo",
  "files": [
    {
      "path": "docs/intro.md",
      "contentType": "text/markdown"
    },
    {
      "path": "assets/logo.png",
      "contentType": "image/png"
    }
  ]
}'

{
  "jobId": "job_01HQXYZ",
  "uploadUrls": {
    "docs/intro.md": "https://s3.example.com/bucket/job_01HQXYZ/docs/intro.md?X-Amz-Signature=abc",
    "assets/logo.png": "https://s3.example.com/bucket/job_01HQXYZ/assets/logo.png?X-Amz-Signature=def"
  }
}

OK