LlamaParse Projects API
The Projects API from LlamaParse — 4 operation(s) for projects.
OpenAPI Specification
openapi: 3.0.3
info:
title: Llama Platform Agent Data Projects API
version: 0.1.0
tags:
- name: Projects
paths:
/api/v1/projects:
get:
tags:
- Projects
summary: List Projects
description: List projects or get one by name
operationId: list_projects_api_v1_projects_get
security:
- HTTPBearer: []
parameters:
- name: organization_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Organization Id
- name: project_name
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Project Name
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Project'
title: Response List Projects Api V1 Projects Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/projects/{project_id}:
get:
tags:
- Projects
summary: Get Project
description: Get a project by ID.
operationId: get_project_api_v1_projects__project_id__get
security:
- HTTPBearer: []
parameters:
- name: project_id
in: path
required: true
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Project Id
- name: organization_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Organization Id
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/Project'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v2/projects:
get:
tags:
- Projects
summary: List Projects
description: List projects in an organization. Requires `organization_id` or a project-scoped API key.
operationId: list_projects_api_v2_projects_get
security:
- HTTPBearer: []
parameters:
- name: organization_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Organization Id
- name: name
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Name
- name: page_size
in: query
required: false
schema:
anyOf:
- type: integer
- type: 'null'
title: Page Size
- name: page_token
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Page Token
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectQueryResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v2/projects/{project_id}:
get:
tags:
- Projects
summary: Get Project
description: Get a project by ID.
operationId: get_project_api_v2_projects__project_id__get
security:
- HTTPBearer: []
parameters:
- name: project_id
in: path
required: true
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Project Id
- name: organization_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Organization Id
- name: session
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
ProjectQueryResponse:
properties:
items:
items:
$ref: '#/components/schemas/ProjectResponse'
type: array
title: Items
description: The list of items.
next_page_token:
anyOf:
- type: string
- type: 'null'
title: Next Page Token
description: A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
total_size:
anyOf:
- type: integer
- type: 'null'
title: Total Size
description: The total number of items available. This is only populated when specifically requested. The value may be an estimate and can be used for display purposes only.
type: object
required:
- items
title: ProjectQueryResponse
description: API query response schema for projects.
ProjectResponse:
properties:
id:
type: string
title: Id
description: The project's unique identifier.
created_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Created At
description: Creation datetime
updated_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Updated At
description: Update datetime
name:
type: string
title: Name
description: The project's display name.
organization_id:
type: string
title: Organization Id
description: The organization the project belongs to.
is_default:
type: boolean
title: Is Default
description: Whether this project is the default project for its organization.
default: false
type: object
required:
- id
- name
- organization_id
title: ProjectResponse
description: API response schema for a project.
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
Project:
properties:
name:
type: string
maxLength: 3000
minLength: 1
title: Name
id:
type: string
format: uuid
title: Id
description: Unique identifier
created_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Created At
description: Creation datetime
updated_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Updated At
description: Update datetime
organization_id:
type: string
format: uuid
title: Organization Id
description: The Organization ID the project is under.
is_default:
type: boolean
title: Is Default
description: Whether this project is the default project for the user.
default: false
type: object
required:
- name
- id
- organization_id
title: Project
description: Schema for a project.
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
securitySchemes:
HTTPBearer:
type: http
scheme: bearer