Start Import

POST

/api/ambitionbox/imports

curl --request POST \
  --url http://localhost:8000/api/ambitionbox/imports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "industry": "example", "limit": 100, "name": "AmbitionBox Companies", "rating": "example", "replace_existing": false, "sort_by": "popular", "workbook_id": "example" }'

• Local API (uvicorn)
• Docker Compose (nginx front)

Start a durable, checkpointed AmbitionBox-to-workbook import.

Authorizations

• OAuth2PasswordBearer

Parameters

Header Parameters

x-workspace-id

Any of:

string

string

null

null

Request Body^required

Media typeapplication/json

AmbitionBoxImportRequest

object

industry

Any of:

string

string

null

null

limit

Limit

integer

default: 100 >= 1 <= 500

name

Name

string

default: AmbitionBox Companies

rating

Any of:

string

string

null

null

replace_existing

Replace Existing

boolean

sort_by

Sort By

string

default: popular /^(popular|rating|reviews)$/

workbook_id

Any of:

string

string

null

null

Responses

202

Successful Response

Media typeapplication/json

Example^generated

example

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

ctx

Context

object

input

Input

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}