Create URI or multipart import

POST /api/v1/workspaces/{workspace}/imports

Operation ID: createImport

Authentication

Use one of the following authentication options. Permissions and workspace scope still apply. See authentication and access control.

Authorization: Bearer YOUR_ACCESS_TOKEN
X-API-Key: YOUR_API_KEY

Parameters

workspace path required: Workspace ID

string

Request body

Required

URI JSON or uploaded vector dataset

Content type application/json

CreateImportURI ↗

Content type multipart/form-data

object

file string · binary required
name string required

Responses

202 Import accepted

Content type application/json

ImportJob ↗

401 Authentication required or credential rejected

Content type application/json

Error ↗

403 Insufficient permission, disabled login, or invalid CSRF

Content type application/json

Error ↗

408 Upload idle or total timeout exceeded

Content type application/json

Error ↗

413 Request body exceeds the configured limit

Content type application/json

Error ↗

422 Invalid import

Content type application/json

Error ↗

426 HTTPS required

Content type application/json

Error ↗

429 Request rate exceeded

Content type application/json

Error ↗

503 Service temporarily unavailable

Content type application/json

Error ↗

OpenAPI operation definition

{
  "operationId": "createImport",
  "parameters": [
    {
      "description": "Workspace ID",
      "in": "path",
      "name": "workspace",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/CreateImportURI"
        }
      },
      "multipart/form-data": {
        "schema": {
          "properties": {
            "file": {
              "format": "binary",
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          },
          "required": [
            "name",
            "file"
          ],
          "type": "object"
        }
      }
    },
    "description": "URI JSON or uploaded vector dataset",
    "required": true
  },
  "responses": {
    "202": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ImportJob"
          }
        }
      },
      "description": "Import accepted"
    },
    "401": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Authentication required or credential rejected"
    },
    "403": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Insufficient permission, disabled login, or invalid CSRF"
    },
    "408": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Upload idle or total timeout exceeded"
    },
    "413": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Request body exceeds the configured limit"
    },
    "422": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Invalid import"
    },
    "426": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "HTTPS required"
    },
    "429": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Request rate exceeded"
    },
    "503": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Service temporarily unavailable"
    }
  },
  "summary": "Create URI or multipart import",
  "tags": [
    "Imports"
  ]
}