Project Jobs

curl --request GET \
  --url https://{host}/api/projects/jobs \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{host}/api/projects/jobs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/api/projects/jobs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/api/projects/jobs"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{host}/api/projects/jobs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "name": "<string>",
  "project_key": "<string>",
  "kind": "<string>",
  "path": "<string>",
  "stats": {
    "total_jobs": 0,
    "running_jobs": 0,
    "succeeded_jobs": 0,
    "failed_jobs": 0,
    "last_submitted_at": "<string>",
    "last_status": "<string>",
    "latest_run_id": "<string>"
  },
  "profile": "<string>",
  "has_config": false,
  "in_repo": false,
  "description": "<string>",
  "visibility": "private",
  "owner_username": "<string>",
  "team_key": "<string>",
  "can_manage": false,
  "jobs": [],
  "matrix_columns": [],
  "total": 0,
  "limit": 0,
  "offset": 0
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

GET

api

projects

jobs

Project Jobs

curl --request GET \
  --url https://{host}/api/projects/jobs \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{host}/api/projects/jobs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/api/projects/jobs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/api/projects/jobs"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{host}/api/projects/jobs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "name": "<string>",
  "project_key": "<string>",
  "kind": "<string>",
  "path": "<string>",
  "stats": {
    "total_jobs": 0,
    "running_jobs": 0,
    "succeeded_jobs": 0,
    "failed_jobs": 0,
    "last_submitted_at": "<string>",
    "last_status": "<string>",
    "latest_run_id": "<string>"
  },
  "profile": "<string>",
  "has_config": false,
  "in_repo": false,
  "description": "<string>",
  "visibility": "private",
  "owner_username": "<string>",
  "team_key": "<string>",
  "can_manage": false,
  "jobs": [],
  "matrix_columns": [],
  "total": 0,
  "limit": 0,
  "offset": 0
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

授权

Authorization

string

header

必填

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

查询参数

project

string

必填

项目键，如 @alice/my-proj 或 experiments/grpo_demo_v1

limit

integer

默认值:100

必填范围: 1 <= x <= 500

offset

integer

默认值:0

必填范围: x >= 0

响应

Successful Response

name

string

必填

project_key

string

必填

kind

string

必填

path

string

必填

stats

ProjectStatsOut · object

必填

Show child attributes

profile

string | null

has_config

boolean

默认值:false

in_repo

boolean

默认值:false

description

string | null

visibility

string

默认值:private

owner_username

string | null

team_key

string | null

can_manage

boolean

默认值:false

jobs

ProjectRunRowOut · object[]

Show child attributes

matrix_columns

ProjectMatrixColumnOut · object[]

Show child attributes

total

integer

默认值:0

limit

integer

默认值:0

offset

integer

默认值:0

开始

接口

Project Jobs

授权

查询参数

响应