/ 
OpenAPI-Client-OpenAI-0.21
River stage zero No dependents
/ OpenAPI::Client::OpenAI::Path::organization-projects

NAME

OpenAPI::Client::OpenAI::Path::organization-projects - Documentation for the /organization/projects path.

DESCRIPTION

This document describes the API endpoint at /organization/projects.

PATHS

GET /organization/projects

Returns a list of projects.

Operation ID

list-projects

$client->list-projects( ... );

Parameters

  • limit (in query) (Optional) - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

    Type: integer

    Default: 20

  • after (in query) (Optional) - A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

    Type: string

  • include_archived (in query) (Optional) - If `true` returns all projects including those that have been `archived`. Archived projects are not included by default.

    Type: boolean

Responses

Status Code: 200

Projects listed successfully.

Content Types:

  • application/json

    Example (See the OpenAI spec for more detail):

    {
   "data" : [
      "{\n    \"id\": \"proj_abc\",\n    \"object\": \"organization.project\",\n    \"name\": \"Project example\",\n    \"created_at\": 1711471533,\n    \"archived_at\": null,\n    \"status\": \"active\"\n}\n"
   ]
}

POST /organization/projects

Create a new project in the organization. Projects can be created and archived, but cannot be deleted.

Operation ID

create-project

$client->create-project( ... );

Parameters

Request Body

Content Type: application/json

Responses

Status Code: 200

Project created successfully.

Content Types:

  • application/json

    Example (See the OpenAI spec for more detail):

    {
    "id": "proj_abc",
    "object": "organization.project",
    "name": "Project example",
    "created_at": 1711471533,
    "archived_at": null,
    "status": "active"
}

SEE ALSO

OpenAPI::Client::OpenAI::Path

COPYRIGHT AND LICENSE

Copyright (C) 2023-2025 by Nelson Ferraz

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.14.0 or, at your option, any later version of Perl 5 you may have available.