|
| 1 | +get: |
| 2 | + tags: |
| 3 | + - Actors/Default build object |
| 4 | + summary: Get default build |
| 5 | + description: | |
| 6 | + Get the default build for an Actor. |
| 7 | + |
| 8 | + Use the optional `waitForFinish` parameter to synchronously wait for the build to finish. |
| 9 | + This avoids the need for periodic polling when waiting for the build to complete. |
| 10 | +
|
| 11 | + This endpoint does not require an authentication token. Instead, calls are authenticated using the build's unique ID. |
| 12 | + However, if you access the endpoint without a token, certain attributes (e.g., `usageUsd` and `usageTotalUsd`) will be hidden. |
| 13 | + operationId: act_build_default_get |
| 14 | + security: |
| 15 | + - apiKeyActorBuilds: [] |
| 16 | + - httpBearerActorBuilds: [] |
| 17 | + parameters: |
| 18 | + - name: actorId |
| 19 | + in: path |
| 20 | + description: Actor ID or a tilde-separated owner's username and Actor name. |
| 21 | + required: true |
| 22 | + style: simple |
| 23 | + schema: |
| 24 | + type: string |
| 25 | + example: janedoe~my-actor |
| 26 | + - name: waitForFinish |
| 27 | + in: query |
| 28 | + description: | |
| 29 | + The maximum number of seconds the server waits for the build to finish. |
| 30 | + If the build finishes within this time, the returned build object will have a terminal status (e.g. `SUCCEEDED`), |
| 31 | + otherwise it will have a transitional status (e.g. `RUNNING`). |
| 32 | + |
| 33 | + By default it is `0`, the maximum value is `60`. <!-- MAX_ACTOR_JOB_ASYNC_WAIT_SECS --> |
| 34 | + style: form |
| 35 | + explode: true |
| 36 | + schema: |
| 37 | + type: number |
| 38 | + format: double |
| 39 | + example: 60 |
| 40 | + responses: |
| 41 | + '200': |
| 42 | + description: '' |
| 43 | + headers: {} |
| 44 | + content: |
| 45 | + application/json: |
| 46 | + schema: |
| 47 | + $ref: '../../components/schemas/actor-builds/GetBuildResponse.yaml' |
| 48 | + example: |
| 49 | + data: |
| 50 | + id: HG7ML7M8z78YcAPEB |
| 51 | + actId: janedoe~my-actor |
| 52 | + userId: klmdEpoiojmdEMlk3 |
| 53 | + startedAt: '2019-11-30T07:34:24.202Z' |
| 54 | + finishedAt: '2019-12-12T09:30:12.202Z' |
| 55 | + status: SUCCEEDED |
| 56 | + meta: |
| 57 | + origin: WEB |
| 58 | + clientIp: 172.234.12.34 |
| 59 | + userAgent: Mozilla/5.0 (iPad) |
| 60 | + stats: |
| 61 | + durationMillis: 1000 |
| 62 | + runTimeSecs: 45.718 |
| 63 | + computeUnits: 0.012699444444444444 |
| 64 | + options: |
| 65 | + useCache: false |
| 66 | + betaPackages: false |
| 67 | + memoryMbytes: 1024 |
| 68 | + diskMbytes: 2048 |
| 69 | + usage: |
| 70 | + ACTOR_COMPUTE_UNITS: 0.08 |
| 71 | + usageTotalUsd: 0.02 |
| 72 | + usageUsd: |
| 73 | + ACTOR_COMPUTE_UNITS: 0.02 |
| 74 | + inputSchema: '{\n \"title\": \"Schema for ... }' |
| 75 | + readme: '# Magic Actor\nThis Actor is magic.' |
| 76 | + buildNumber: 0.1.1 |
0 commit comments