Examples

Examples

1. Create a New User (Admin Only)

Request:

POST /create-user HTTP/1.1
Host: api.example.com
Authorization: Basic YWRtaW46U2VjdXJlUGFzczE=
Content-Type: application/json

{
  "username": "john_doe",
  "password": "SecurePass1"
}

Response:

{
  "message": "User created successfully."
}

2. Assign an API Key to a User (Admin Only)

Request:

POST /assign-api-key HTTP/1.1
Host: api.example.com
Authorization: Basic YWRtaW46U2VjdXJlUGFzczE=
Content-Type: application/json

{
  "username": "john_doe"
}

Response:

{
  "message": "API key generated successfully.",
  "api_key": "op-1a2b3c4d5e-6f7g8h9i0j"
}

3. Upload a PDF (Authenticated User)

Request:

POST /upload-pdf HTTP/1.1
Host: api.example.com
Authorization: Bearer op-1a2b3c4d5e-6f7g8h9i0j
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="file"; filename="document.pdf"
Content-Type: application/pdf

<binary data>
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="metadata"

{
  "fields": {
    "name": "string",
    "age": "integer",
    "email": "string"
  },
  "model_name": "UserModel"
}
------WebKitFormBoundary7MA4YWxkTrZu0gW--

Response:

{
  "message": "File uploaded successfully.",
  "file_id": "9f86d081884c7d659a2feaa0c55ad015",
  "gcs_url": "https://storage.googleapis.com/vision-bucket-ai/document.pdf"
}

4. Get Processing Response

Request:

GET /response?file_id=9f86d081884c7d659a2feaa0c55ad015 HTTP/1.1
Host: api.example.com

Response:

{
  "result": {
    "completion_time": "2025-01-09T12:34:56Z",
    "file_name": "document.pdf",
    "input_tokens": 1234,
    "output_tokens": 5678,
    "pages": [
      {
        "content": "Page 1 content in markdown...",
        "content_length": 1024,
        "page_number": 1
      },
      {
        "content": "Page 2 content in markdown...",
        "content_length": 2048,
        "page_number": 2
      }
    ]
  },
  "chunks": []
}

---