resources/admin/index.md +95 −29
7381 7381
7382 The name of the project. This appears in reporting.7382 The name of the project. This appears in reporting.
7383 7383
73847384 - `residency: optional "GLOBAL" or "US_STORAGE_PROCESSING" or "EU_STORAGE_PROCESSING" or 9 more` - `residency: optional ProjectResidency`
7385 7385
7386 The residency configuration for the project.7386 The residency configuration for the project.
7387 7387
7473 7473
7474 External key ID to associate with the project.7474 External key ID to associate with the project.
7475 7475
74767476- `residency: optional "GLOBAL" or "US_STORAGE_PROCESSING" or "EU_STORAGE_PROCESSING" or 9 more or null`- `geography: optional string or null`
7477
7478 Create the project with the specified data residency region. Your organization must have access to Data residency functionality in order to use. See [data residency controls](/docs/guides/your-data#data-residency-controls) to review the functionality and limitations of setting this field.
7479 Deprecated: use `residency` instead. Do not provide both `geography` and `residency`.
7480
7481- `residency: optional ProjectResidency or null`
7477 7482
7478 Create the project with the specified residency configuration. Your organization must have access to the requested residency configuration in order to use it. See [data residency controls](/docs/guides/your-data#data-residency-controls) to review the functionality and limitations of setting this field.7483 Create the project with the specified residency configuration. Your organization must have access to the requested residency configuration in order to use it. See [data residency controls](/docs/guides/your-data#data-residency-controls) to review the functionality and limitations of setting this field.
7479 7484
7533 7538
7534 The name of the project. This appears in reporting.7539 The name of the project. This appears in reporting.
7535 7540
75367541 - `residency: optional "GLOBAL" or "US_STORAGE_PROCESSING" or "EU_STORAGE_PROCESSING" or 9 more` - `residency: optional ProjectResidency`
7537 7542
7538 The residency configuration for the project.7543 The residency configuration for the project.
7539 7544
7665 7670
7666 The name of the project. This appears in reporting.7671 The name of the project. This appears in reporting.
7667 7672
76687673 - `residency: optional "GLOBAL" or "US_STORAGE_PROCESSING" or "EU_STORAGE_PROCESSING" or 9 more` - `residency: optional ProjectResidency`
7669 7674
7670 The residency configuration for the project.7675 The residency configuration for the project.
7671 7676
7808 7813
7809 The name of the project. This appears in reporting.7814 The name of the project. This appears in reporting.
7810 7815
78117816 - `residency: optional "GLOBAL" or "US_STORAGE_PROCESSING" or "EU_STORAGE_PROCESSING" or 9 more` - `residency: optional ProjectResidency`
7812 7817
7813 The residency configuration for the project.7818 The residency configuration for the project.
7814 7819
7899 7904
7900 External key ID to associate with the project.7905 External key ID to associate with the project.
7901 7906
7907- `geography: optional string or null`
7908
7909 Geography for the project.
7910 Deprecated: use `residency` when creating a project to configure data residency. This field is retained for backward compatibility.
7911
7902- `name: optional string or null`7912- `name: optional string or null`
7903 7913
7904 The updated name of the project, this name appears in reports.7914 The updated name of the project, this name appears in reports.
7935 7945
7936 The name of the project. This appears in reporting.7946 The name of the project. This appears in reporting.
7937 7947
79387948 - `residency: optional "GLOBAL" or "US_STORAGE_PROCESSING" or "EU_STORAGE_PROCESSING" or 9 more` - `residency: optional ProjectResidency`
7939 7949
7940 The residency configuration for the project.7950 The residency configuration for the project.
7941 7951
8036 8046
8037 The name of the project. This appears in reporting.8047 The name of the project. This appears in reporting.
8038 8048
80398049 - `residency: optional "GLOBAL" or "US_STORAGE_PROCESSING" or "EU_STORAGE_PROCESSING" or 9 more` - `residency: optional ProjectResidency`
8040 8050
8041 The residency configuration for the project.8051 The residency configuration for the project.
8042 8052
8068 8078
8069 `active` or `archived`8079 `active` or `archived`
8070 8080
8081### Project Residency
8082
8083- `ProjectResidency = "GLOBAL" or "US_STORAGE_PROCESSING" or "EU_STORAGE_PROCESSING" or 9 more`
8084
8085 - `"GLOBAL"`
8086
8087 - `"US_STORAGE_PROCESSING"`
8088
8089 - `"EU_STORAGE_PROCESSING"`
8090
8091 - `"JP_STORAGE"`
8092
8093 - `"KR_STORAGE"`
8094
8095 - `"CA_STORAGE"`
8096
8097 - `"SG_STORAGE"`
8098
8099 - `"IN_STORAGE"`
8100
8101 - `"AU_STORAGE"`
8102
8103 - `"GB_STORAGE"`
8104
8105 - `"AE_STORAGE"`
8106
8107 - `"AE_STORAGE_PROCESSING"`
8108
8071# API Keys8109# API Keys
8072 8110
8073## Delete project API key8111## Delete project API key
17507 17545
17508 When `group_by=line_item`, this field provides the quantity of the grouped costs result.17546 When `group_by=line_item`, this field provides the quantity of the grouped costs result.
17509 17547
1751017548 - `quantity_unit: optional string or "tokens" or "1000_tokens" or "duration_seconds" or 5 more or null` - `quantity_unit: optional CostQuantityUnit or null`
17511 17549
17512 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.17550 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.
17513 17551
18099 18137
18100 When `group_by=line_item`, this field provides the quantity of the grouped costs result.18138 When `group_by=line_item`, this field provides the quantity of the grouped costs result.
18101 18139
1810218140 - `quantity_unit: optional string or "tokens" or "1000_tokens" or "duration_seconds" or 5 more or null` - `quantity_unit: optional CostQuantityUnit or null`
18103 18141
18104 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.18142 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.
18105 18143
18673 18711
18674 When `group_by=line_item`, this field provides the quantity of the grouped costs result.18712 When `group_by=line_item`, this field provides the quantity of the grouped costs result.
18675 18713
1867618714 - `quantity_unit: optional string or "tokens" or "1000_tokens" or "duration_seconds" or 5 more or null` - `quantity_unit: optional CostQuantityUnit or null`
18677 18715
18678 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.18716 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.
18679 18717
19269 19307
19270 When `group_by=line_item`, this field provides the quantity of the grouped costs result.19308 When `group_by=line_item`, this field provides the quantity of the grouped costs result.
19271 19309
1927219310 - `quantity_unit: optional string or "tokens" or "1000_tokens" or "duration_seconds" or 5 more or null` - `quantity_unit: optional CostQuantityUnit or null`
19273 19311
19274 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.19312 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.
19275 19313
19858 19896
19859 When `group_by=line_item`, this field provides the quantity of the grouped costs result.19897 When `group_by=line_item`, this field provides the quantity of the grouped costs result.
19860 19898
1986119899 - `quantity_unit: optional string or "tokens" or "1000_tokens" or "duration_seconds" or 5 more or null` - `quantity_unit: optional CostQuantityUnit or null`
19862 19900
19863 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.19901 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.
19864 19902
20453 20491
20454 When `group_by=line_item`, this field provides the quantity of the grouped costs result.20492 When `group_by=line_item`, this field provides the quantity of the grouped costs result.
20455 20493
2045620494 - `quantity_unit: optional string or "tokens" or "1000_tokens" or "duration_seconds" or 5 more or null` - `quantity_unit: optional CostQuantityUnit or null`
20457 20495
20458 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.20496 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.
20459 20497
21045 21083
21046 When `group_by=line_item`, this field provides the quantity of the grouped costs result.21084 When `group_by=line_item`, this field provides the quantity of the grouped costs result.
21047 21085
2104821086 - `quantity_unit: optional string or "tokens" or "1000_tokens" or "duration_seconds" or 5 more or null` - `quantity_unit: optional CostQuantityUnit or null`
21049 21087
21050 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.21088 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.
21051 21089
21664 21702
21665 When `group_by=line_item`, this field provides the quantity of the grouped costs result.21703 When `group_by=line_item`, this field provides the quantity of the grouped costs result.
21666 21704
2166721705 - `quantity_unit: optional string or "tokens" or "1000_tokens" or "duration_seconds" or 5 more or null` - `quantity_unit: optional CostQuantityUnit or null`
21668 21706
21669 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.21707 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.
21670 21708
22258 22296
22259 When `group_by=line_item`, this field provides the quantity of the grouped costs result.22297 When `group_by=line_item`, this field provides the quantity of the grouped costs result.
22260 22298
2226122299 - `quantity_unit: optional string or "tokens" or "1000_tokens" or "duration_seconds" or 5 more or null` - `quantity_unit: optional CostQuantityUnit or null`
22262 22300
22263 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.22301 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.
22264 22302
22832 22870
22833 When `group_by=line_item`, this field provides the quantity of the grouped costs result.22871 When `group_by=line_item`, this field provides the quantity of the grouped costs result.
22834 22872
2283522873 - `quantity_unit: optional string or "tokens" or "1000_tokens" or "duration_seconds" or 5 more or null` - `quantity_unit: optional CostQuantityUnit or null`
22836 22874
22837 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.22875 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.
22838 22876
23432 23470
23433 When `group_by=line_item`, this field provides the quantity of the grouped costs result.23471 When `group_by=line_item`, this field provides the quantity of the grouped costs result.
23434 23472
2343523473 - `quantity_unit: optional string or "tokens" or "1000_tokens" or "duration_seconds" or 5 more or null` - `quantity_unit: optional CostQuantityUnit or null`
23436 23474
23437 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.23475 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.
23438 23476
23557 23595
23558## Domain Types23596## Domain Types
23559 23597
23598### Cost Quantity Unit
23599
23600- `CostQuantityUnit = string or "tokens" or "1000_tokens" or "duration_seconds" or 5 more`
23601
23602 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.
23603
23604 - `string`
23605
23606 - `"tokens" or "1000_tokens" or "duration_seconds" or 5 more`
23607
23608 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.
23609
23610 - `"tokens"`
23611
23612 - `"1000_tokens"`
23613
23614 - `"duration_seconds"`
23615
23616 - `"duration_minutes"`
23617
23618 - `"duration_hours"`
23619
23620 - `"gibibyte_hours"`
23621
23622 - `"images"`
23623
23624 - `"characters"`
23625
23560### Usage Audio Speeches Response23626### Usage Audio Speeches Response
23561 23627
23562- `UsageAudioSpeechesResponse object { data, has_more, next_page, object }`23628- `UsageAudioSpeechesResponse object { data, has_more, next_page, object }`
23963 24029
23964 When `group_by=line_item`, this field provides the quantity of the grouped costs result.24030 When `group_by=line_item`, this field provides the quantity of the grouped costs result.
23965 24031
2396624032 - `quantity_unit: optional string or "tokens" or "1000_tokens" or "duration_seconds" or 5 more or null` - `quantity_unit: optional CostQuantityUnit or null`
23967 24033
23968 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.24034 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.
23969 24035
24405 24471
24406 When `group_by=line_item`, this field provides the quantity of the grouped costs result.24472 When `group_by=line_item`, this field provides the quantity of the grouped costs result.
24407 24473
2440824474 - `quantity_unit: optional string or "tokens" or "1000_tokens" or "duration_seconds" or 5 more or null` - `quantity_unit: optional CostQuantityUnit or null`
24409 24475
24410 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.24476 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.
24411 24477
24847 24913
24848 When `group_by=line_item`, this field provides the quantity of the grouped costs result.24914 When `group_by=line_item`, this field provides the quantity of the grouped costs result.
24849 24915
2485024916 - `quantity_unit: optional string or "tokens" or "1000_tokens" or "duration_seconds" or 5 more or null` - `quantity_unit: optional CostQuantityUnit or null`
24851 24917
24852 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.24918 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.
24853 24919
25289 25355
25290 When `group_by=line_item`, this field provides the quantity of the grouped costs result.25356 When `group_by=line_item`, this field provides the quantity of the grouped costs result.
25291 25357
2529225358 - `quantity_unit: optional string or "tokens" or "1000_tokens" or "duration_seconds" or 5 more or null` - `quantity_unit: optional CostQuantityUnit or null`
25293 25359
25294 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.25360 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.
25295 25361
25731 25797
25732 When `group_by=line_item`, this field provides the quantity of the grouped costs result.25798 When `group_by=line_item`, this field provides the quantity of the grouped costs result.
25733 25799
2573425800 - `quantity_unit: optional string or "tokens" or "1000_tokens" or "duration_seconds" or 5 more or null` - `quantity_unit: optional CostQuantityUnit or null`
25735 25801
25736 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.25802 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.
25737 25803
26173 26239
26174 When `group_by=line_item`, this field provides the quantity of the grouped costs result.26240 When `group_by=line_item`, this field provides the quantity of the grouped costs result.
26175 26241
2617626242 - `quantity_unit: optional string or "tokens" or "1000_tokens" or "duration_seconds" or 5 more or null` - `quantity_unit: optional CostQuantityUnit or null`
26177 26243
26178 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.26244 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.
26179 26245
26615 26681
26616 When `group_by=line_item`, this field provides the quantity of the grouped costs result.26682 When `group_by=line_item`, this field provides the quantity of the grouped costs result.
26617 26683
2661826684 - `quantity_unit: optional string or "tokens" or "1000_tokens" or "duration_seconds" or 5 more or null` - `quantity_unit: optional CostQuantityUnit or null`
26619 26685
26620 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.26686 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.
26621 26687
27057 27123
27058 When `group_by=line_item`, this field provides the quantity of the grouped costs result.27124 When `group_by=line_item`, this field provides the quantity of the grouped costs result.
27059 27125
2706027126 - `quantity_unit: optional string or "tokens" or "1000_tokens" or "duration_seconds" or 5 more or null` - `quantity_unit: optional CostQuantityUnit or null`
27061 27127
27062 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.27128 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.
27063 27129
27499 27565
27500 When `group_by=line_item`, this field provides the quantity of the grouped costs result.27566 When `group_by=line_item`, this field provides the quantity of the grouped costs result.
27501 27567
2750227568 - `quantity_unit: optional string or "tokens" or "1000_tokens" or "duration_seconds" or 5 more or null` - `quantity_unit: optional CostQuantityUnit or null`
27503 27569
27504 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.27570 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.
27505 27571
27941 28007
27942 When `group_by=line_item`, this field provides the quantity of the grouped costs result.28008 When `group_by=line_item`, this field provides the quantity of the grouped costs result.
27943 28009
2794428010 - `quantity_unit: optional string or "tokens" or "1000_tokens" or "duration_seconds" or 5 more or null` - `quantity_unit: optional CostQuantityUnit or null`
27945 28011
27946 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.28012 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.
27947 28013
28383 28449
28384 When `group_by=line_item`, this field provides the quantity of the grouped costs result.28450 When `group_by=line_item`, this field provides the quantity of the grouped costs result.
28385 28451
2838628452 - `quantity_unit: optional string or "tokens" or "1000_tokens" or "duration_seconds" or 5 more or null` - `quantity_unit: optional CostQuantityUnit or null`
28387 28453
28388 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.28454 The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.
28389 28455