NAME

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

OPERATIONS

GET /organization/projects/{project_id}

retrieve-project

$client->retrieve_project({
    body => { ... },
});

Retrieves a project.

Path/query parameters

• project_id (in path, required, string) - The ID of the project.

Responses

200 - Project retrieved successfully.

Content-Type: application/json

Example:

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

POST /organization/projects/{project_id}

modify-project

$client->modify_project({
    body => { ... },
});

Modifies a project in the organization.

Path/query parameters

• project_id (in path, required, string) - The ID of the project.

Responses

200 - Project updated successfully.

Content-Type: application/json

Example:

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

400 - Error response when updating the default project.

Content-Type: application/json

Example:

{
   "error" : {
      "code" : "string",
      "message" : "string",
      "param" : "string",
      "type" : "string"
   }
}

SCHEMAS

Error

Properties:

• code (anyOf, required)

• message (string, required)

• param (anyOf, required)

• type (string, required)

ErrorResponse

Properties:

• error (Error, required)

  See "Error" below for shape.

Project

Properties:

• archived_at (anyOf)

• created_at (integer, required) - The Unix timestamp (in seconds) of when the project was created.

• external_key_id (anyOf) - The external key associated with the project.

• id (string, required) - The identifier, which can be referenced in API endpoints

• name (anyOf) - The name of the project. This appears in reporting.

• object (string, required) - The object type, which is always organization.project

  Allowed values: organization.project

• status (anyOf) - active or archived

ProjectUpdateRequest

Properties:

• external_key_id (anyOf) - External key ID to associate with the project.

• geography (anyOf) - Geography for the project.

• name (anyOf) - The updated name of the project, this name appears in reports.

SEE ALSO

OpenAPI::Client::OpenAI::Path

COPYRIGHT AND LICENSE

Copyright (C) 2023-2026 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