NAME

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

DESCRIPTION

This document describes the API endpoint at /organization/projects/{project_id}.

PATHS

GET /organization/projects/{project_id}

Retrieves a project.

Operation ID

retrieve-project

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

Parameters

• project_id (in path) (Required) - The ID of the project.

  Type: string

Responses

Status Code: 200

Project retrieved 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"
  }

POST /organization/projects/{project_id}

Modifies a project in the organization.

Operation ID

modify-project

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

Parameters

• project_id (in path) (Required) - The ID of the project.

  Type: string

Request Body

Content Type: application/json

Responses

Status Code: 200

Project updated 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"
  }

Status Code: 400

Error response when updating the default project.

Content Types:

• application/json

  Example (See the OpenAI spec for more detail):

  {
     "error" : null
  }

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.

cpanm OpenAPI::Client::OpenAI

perl -MCPAN -e shell
install OpenAPI::Client::OpenAI