API Reference

Projects

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Retrieve project

projects().retrieve(ProjectRetrieveParamsparams = ProjectRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none()) : Project

GET/v0/projects/{project}

Retrieve a project by name.

ParametersExpand Collapse

params: ProjectRetrieveParams

project: Optional<String>

ReturnsExpand Collapse

class Project:

A project is a collection of SDKs generated from the same set of config files.

configRepo: String

displayName: Optional<String>

object_: Object

org: String

slug: String

targets: List<Target>

One of the following:

NODE("node")

TYPESCRIPT("typescript")

PYTHON("python")

GO("go")

JAVA("java")

KOTLIN("kotlin")

RUBY("ruby")

TERRAFORM("terraform")

CLI("cli")

PHP("php")

CSHARP("csharp")

SQL("sql")

OPENAPI("openapi")

Retrieve project

Kotlin

HTTP

TypeScript

Python

Java

Kotlin

Go

Ruby

CLI Tool

PHP

C#

package com.configure_me_stainless_v0.api.example

import com.configure_me_stainless_v0.api.client.StainlessClient
import com.configure_me_stainless_v0.api.client.okhttp.StainlessOkHttpClient
import com.configure_me_stainless_v0.api.models.projects.Project
import com.configure_me_stainless_v0.api.models.projects.ProjectRetrieveParams

fun main() {
    val client: StainlessClient = StainlessOkHttpClient.builder()
        .fromEnv()
        .project("example-project")
        .build()

    val project: Project = client.projects().retrieve()
}

200 example

{
  "config_repo": "config_repo",
  "display_name": "display_name",
  "object": "project",
  "org": "org",
  "slug": "slug",
  "targets": [
    "node"
  ]
}

Returns Examples

200 example

{
  "config_repo": "config_repo",
  "display_name": "display_name",
  "object": "project",
  "org": "org",
  "slug": "slug",
  "targets": [
    "node"
  ]
}