OBJECT
Query
Queries are used to retrieve data. If you're new to our API,
try the me
query to explore the information you have access to.
Hit ctrl-space
at any time to activate field completion hints, and
mouse over a field or parameter to see its documentation.
link GraphQL Schema definition
1 type Query { 2 3 # Retrieve a list of temporal data objects. 4 # Example: 5 # Request: 6 # query { 7 # 8 # temporalDataObjects( 9 # 10 # organizationId: "35521"){ 11 # 12 # records{name} 13 # 14 # offset 15 # 16 # limit 17 # 18 # count 19 # 20 # } 21 # } 22 # Response: 23 # { 24 # 25 # "data": { 26 # 27 # "temporalDataObjects": { 28 # 29 # "records": [ 30 # 31 # { 32 # 33 # "name": "example" 34 # 35 # }, 36 # 37 # { 38 # 39 # "name": "example" 40 # 41 # }, 42 # 43 # ], 44 # 45 # "offset": 0, 46 # 47 # "limit": 30, 48 # 49 # "count": 8 50 # 51 # } 52 # 53 # } 54 # } 55 # 56 # Arguments 57 # organizationId: Organization ID to get TDOs for. Defaults to 58 # the user's own organization. 59 # You can only retrieves content for your own organizations or organizations 60 # that have shared data with yours. 61 # applicationId: Application ID (an authorization construct that 62 # maps directly to organization ID) 63 # to get TDOs for. Defaults to the user's own organization. 64 # id: Provide a list of IDs to retrieve the specific TDOs. 65 # offset: Provide an offset to skip to a certain element in the 66 # result, for paging. 67 # limit: Specify maximum number of results to retrieve in this 68 # result. Page size. 69 # sourceId: Optionally, specify a source ID. TDOs ingested from 70 # this source will 71 # be returned. 72 # programId: Optionally, specify a program ID. TDOs belong to 73 # this program will 74 # be returned. 75 # scheduledJobId: Optionally, specify a scheduled job ID. TDOs 76 # ingested under this 77 # scheduled job will be returned. 78 # sampleMedia: Whether to retrieve only tdos with the specified 79 # sampleMedia value 80 # includePublic: Whether to retrieve public data that is not part 81 # of the user's organization. 82 # The default is false. Pass true to include public data in the result set. 83 # dateTimeFilter: Provide optional filters against any date/time 84 # field to filter 85 # objects within a given time window. 86 # Matching objects must meet all of the given conditions. 87 # mentionId: Retrieve TDOs associated with the given mention 88 ( 89 ID, : 90 ID, : 91 ID, : 92 ID], : [ 93 Int, : 94 Int, : 95 ID, : 96 ID, : 97 ID, : 98 Boolean, : 99 Boolean, : 100 TemporalDataObjectOrderBy, : 101 OrderDirection, : 102 TemporalDataObjectDateTimeFilter!], : [ 103 ID : 104 ): TDOList 105 106 # Retrieve a single temporal data object 107 # Example: 108 # Request: 109 # query { 110 # 111 # temporalDataObject( 112 # 113 # id: 1570654874) { 114 # 115 # id 116 # 117 # name 118 # 119 # } 120 # } 121 # Response: 122 # { 123 # 124 # "data": { 125 # 126 # "temporalDataObject": { 127 # 128 # "id": "1570654874", 129 # 130 # "name": "example" 131 # 132 # } 133 # 134 # } 135 # } 136 # 137 # Arguments 138 # id: the TDO ID 139 ID!): TemporalDataObject ( : 140 141 # Retrieve a single Asset 142 # Example: 143 # Request: 144 # query { 145 # 146 # asset( 147 # 148 # id: "1570654874_4hJtNKSUXD") { 149 # 150 # id 151 # 152 # name 153 # 154 # description 155 # 156 # } 157 # } 158 # Response: 159 # { 160 # 161 # "data": { 162 # 163 # "asset": { 164 # 165 # "id": "1570654874_4hJtNKSUXD", 166 # 167 # "name": "example", 168 # 169 # "description": "example" 170 # 171 # } 172 # 173 # } 174 # } 175 # 176 # Arguments 177 # id: The asset ID 178 ID!): Asset ( : 179 180 # Retrieve multiple assets 181 # Example: 182 # Request: 183 # query { 184 # 185 # assets( 186 # 187 # ids:["1570654874_4hJtNKSUXD"], 188 # 189 # contentTypes:[], 190 # 191 # assetTypes:["text"], 192 # 193 # sourceEngineIds:[], 194 # 195 # createdDateFilter:null, 196 # 197 # scrollId: null){ 198 # 199 # assets{ 200 # 201 # records{id} 202 # 203 # count 204 # 205 # } 206 # 207 # scrollId 208 # 209 # } 210 # } 211 # Response: 212 # { 213 # 214 # "data": { 215 # 216 # "assets": { 217 # 218 # "assets": { 219 # 220 # "records": [], 221 # 222 # "count": 0 223 # 224 # }, 225 # 226 # "scrollId": "" 227 # 228 # } 229 # 230 # } 231 # } 232 # 233 # Arguments 234 # ids: List of asset ids 235 # contentTypes: Filter assets with content type included in the 236 # list 237 # See https://www.iana.org/assignments/media-types/media-types.xhtml 238 # assetTypes: Filter assets with assetType included in the list 239 # See https://docs.veritone.com/#/apis/tutorials/asset-types for list of values. 240 # sourceEngineIds: Filter by source engine. 241 # Not all assets have associated engineId, ex. media assets 242 # createdDateFilter: Filter by created date 243 # Note createdDateFilter.filter is required, but currently ignored 244 # offset: Offset to skip to a certain element in the result, for 245 # paging. 246 # limit: Maximum number of results to retrieve in this result. 247 # Page size. 248 # scrollId: Use this field when sequentially iterating over the 249 # assets list 250 # This is required for when offset + limit exceeds 10000. 251 # The value of this field is set from the response of the first/previous 252 # assets query 253 ( 254 ID!], : [ 255 String!], : [ 256 String!], : [ 257 String!], : [ 258 TemporalDataObjectDateTimeFilter, : 259 Int, : 260 Int, : 261 String : 262 ): AssetScrollList 263 264 # Retrieve a single Widget 265 # Example: 266 # Request: 267 # query { 268 # 269 # widget( 270 # 271 # id: "KOIFUT_rT_Oy3Ev9zfKT6A") { 272 # 273 # collection{ 274 # 275 # id 276 # 277 # } 278 # 279 # } 280 # } 281 # Response: 282 # { 283 # 284 # "data": { 285 # 286 # "widget": { 287 # 288 # "collection": { 289 # 290 # "id": "243625" 291 # 292 # } 293 # 294 # } 295 # 296 # } 297 # } 298 # 299 # Arguments 300 # id: The widget ID 301 ID!): Widget ( : 302 303 # Retrieve clone job entries 304 # Example: 305 # Request: 306 # query { 307 # 308 # cloneRequests { 309 # 310 # records{ 311 # 312 # id 313 # 314 # } 315 # 316 # } 317 # } 318 # 319 # Response: 320 # 321 # { 322 # 323 # "data": { 324 # 325 # "cloneRequests": { 326 # 327 # "records": [] 328 # 329 # } 330 # 331 # } 332 # } 333 # 334 # Arguments 335 # id: Provide an ID to retrieve a single specific clone request. 336 # applicationId: Application ID to get clone requests for. 337 # Defaults to the user's own application. 338 ID, : ID, : Int, : Int): CloneRequestList ( : 339 340 # Retrieve most recent builds 341 # Example: 342 # Request: 343 # query { 344 # 345 # recentBuilds(limit:2) { 346 # 347 # records{ 348 # 349 # id 350 # 351 # name 352 # 353 # } 354 # 355 # } 356 # } 357 # Response: 358 # { 359 # 360 # "data": { 361 # 362 # "recentBuilds": { 363 # 364 # "records": [ 365 # 366 # { 367 # 368 # "id": "44193f81-57b4-47dd-9fe0-be95000776d9", 369 # 370 # "name": "example Version 5" 371 # 372 # }, 373 # 374 # { 375 # 376 # "id": "bae12129-2724-40c3-abd2-6bb4021f21ae", 377 # 378 # "name": "example Version 4" 379 # 380 # } 381 # 382 # ] 383 # 384 # } 385 # 386 # } 387 # } 388 # 389 # Arguments 390 # buildStatus: Engine build status: 391 # offset: Specify maximum number of results to retrieve in this 392 # result. Page size. 393 # limit: Specify maximum number of results to retrieve in this 394 # result. 395 # orderBy: Set order information on the query. Multiple fields 396 # are supported. 397 # Default order by modifiedDateTime desc 398 ( 399 BuildStatus!], : [ 400 Int, : 401 Int, : 402 EngineBuildOrderBy!] : [ 403 ): BuildList 404 405 # Retrieve engine overview 406 # Example: 407 # Request: 408 # query { 409 # 410 # engineOverview { 411 # 412 # ready 413 # 414 # } 415 # } 416 # 417 # Response: 418 # 419 # { 420 # 421 # "data": { 422 # 423 # "engineOverview": { 424 # 425 # "ready": 7 426 # 427 # } 428 # 429 # } 430 # } 431 EngineOverview : 432 433 # Retrieve engines 434 # Example: 435 # Request: 436 # query { 437 # 438 # engines(limit:2) { 439 # 440 # records{ 441 # 442 # id 443 # 444 # state 445 # 446 # } 447 # 448 # } 449 # } 450 # Response: 451 # { 452 # 453 # "data": { 454 # 455 # "engines": { 456 # 457 # "records": [ 458 # 459 # { 460 # 461 # "id": "2", 462 # 463 # "state": "pending" 464 # 465 # }, 466 # 467 # { 468 # 469 # "id": "1", 470 # 471 # "state": "pending" 472 # 473 # } 474 # 475 # ] 476 # 477 # } 478 # 479 # } 480 # } 481 # 482 # Arguments 483 # id: Provide an ID to retrieve a single specific engine. 484 # categoryId: Provide a category ID to filter by engine category. 485 # category: provide a category name or ID to filter by engine 486 # category 487 # state: Provide a list of states to filter by engine state. 488 # owned: If true, return only engines owned by the user's 489 # organization. 490 # libraryRequired: If true, return only engines that require a 491 # library. 492 # createsTDO: If true, return only engines that create their own 493 # TDO. 494 # If false, return only engines that do not create a TDO. 495 # If not set, return either. 496 # name: Provide a name, or part of a name, to search by engine 497 # name 498 # offset: Specify maximum number of results to retrieve in this 499 # result. Page size. 500 # limit: Specify maximum number of results to retrieve in this 501 # result. 502 # filter: Filters for engine attributes 503 # orderBy: Provide a list of EngineSortField to sort by. 504 # edgeVersion: Edge version to filter 505 ( 506 ID, : 507 ID!], : [ 508 String, : 509 String, : 510 EngineState], : [ 511 Boolean, : 512 Boolean, : 513 Boolean, : 514 String, : 515 Int, : 516 Int, : 517 EngineFilter, : 518 EngineSortField], : [ 519 Int : 520 ): EngineList 521 522 # Retrieve a single engine by ID 523 # Example: 524 # Request: 525 # query { 526 # 527 # engine(id:1) { 528 # 529 # name 530 # 531 # state 532 # 533 # } 534 # } 535 # Response: 536 # { 537 # 538 # "data": { 539 # 540 # "engine": { 541 # 542 # "name": "example", 543 # 544 # "state": "pending" 545 # 546 # } 547 # 548 # } 549 # } 550 # 551 # Arguments 552 # id: Provide the engine ID 553 ID!): Engine ( : 554 555 # Retrieve an engine build 556 # Example: 557 # Request: 558 # query { 559 # 560 # engineBuild(id: "2a1a1b58-6983-4002-b9ed-7b7f325f621a"){ 561 # 562 # name 563 # 564 # engineId 565 # 566 # } 567 # } 568 # 569 # Response: 570 # { 571 # 572 # "data": { 573 # 574 # "engineBuild": { 575 # 576 # "name": "example Version 1", 577 # 578 # "engineId": "1" 579 # 580 # } 581 # 582 # } 583 # } 584 # 585 # Arguments 586 # id: Provide the build ID 587 ID!): Build ( : 588 589 # Retrieve engine categories 590 # Example: 591 # Request: 592 # query { 593 # 594 # engineCategories(limit:2) { 595 # 596 # records { 597 # 598 # id 599 # 600 # type { 601 # 602 # name 603 # 604 # } 605 # 606 # name 607 # 608 # } 609 # 610 # } 611 # } 612 # Response: 613 # { 614 # 615 # "data": { 616 # 617 # "engineCategories": { 618 # 619 # "records": [ 620 # 621 # { 622 # 623 # "id": "581dbb32-ea5b-4458-bd15-8094942345e3", 624 # 625 # "type": { 626 # 627 # "name": "Cognition" 628 # 629 # }, 630 # 631 # "name": "Transcode" 632 # 633 # }, 634 # 635 # { 636 # 637 # "id": "67cd4dd0-2f75-445d-a6f0-2f297d6cd182", 638 # 639 # "type": { 640 # 641 # "name": "Cognition" 642 # 643 # }, 644 # 645 # "name": "Transcription" 646 # 647 # } 648 # 649 # ] 650 # 651 # } 652 # 653 # } 654 # } 655 # 656 # Arguments 657 # id: Provide an ID to retrieve a single specific engine 658 # category. 659 # ids: Provide multiple IDs to retrieve engine categories 660 # name: Provide a name, or part of one, to search by category 661 # name 662 # type: Return all categories of an engine type 663 # offset: Specify maximum number of results to retrieve in this 664 # result. Page size. 665 # limit: Specify maximum number of results to retrieve in this 666 # result. 667 ( 668 ID, : 669 ID!], : [ 670 String, : 671 String, : 672 Int, : 673 Int : 674 ): EngineCategoryList 675 676 # Retrieve a specific engine category\ 677 # Example: 678 # Request: 679 # query { 680 # 681 # engineCategory(id: "581dbb32-ea5b-4458-bd15-8094942345e3") { 682 # 683 # name 684 # 685 # type{ 686 # 687 # name 688 # 689 # } 690 # 691 # } 692 # } 693 # Response: 694 # { 695 # 696 # "data": { 697 # 698 # "engineCategory": { 699 # 700 # "name": "Transcode", 701 # 702 # "type": { 703 # 704 # "name": "Cognition" 705 # 706 # } 707 # 708 # } 709 # 710 # } 711 # } 712 # 713 # Arguments 714 # id: Supply the ID of the engine category to retrieve 715 ID!): EngineCategory ( : 716 717 # Retrieve jobs 718 # Example: 719 # Request: 720 # query { 721 # 722 # jobs(limit:2) { 723 # 724 # records{ 725 # 726 # id 727 # 728 # name 729 # 730 # } 731 # 732 # } 733 # } 734 # Response: 735 # { 736 # 737 # "data": { 738 # 739 # "jobs": { 740 # 741 # "records": [] 742 # 743 # } 744 # 745 # } 746 # } 747 # 748 # Arguments 749 # id: Provide an ID to retrieve a single specific job. 750 # status: Provide a list of status strings to filter by status 751 # offset: Provide an offset to skip to a certain element in the 752 # result, for paging. 753 # limit: Specify the maximum number of results to included in 754 # this response, or page size. 755 # applicationId: Provide an application ID to filter jobs for a 756 # given application. 757 # Defaults to the user's own application. 758 # targetId: Provide a target ID to get the set of jobs running 759 # against a particular TDO. 760 # clusterId: Provide a cluster ID to get the jobs running on a 761 # specific cluster 762 # scheduledJobIds: Provide a list of scheduled job IDs to get 763 # jobs associated with the scheduled jobs 764 # hasScheduledJobId: Return only jobs that are (true) or are not 765 # (false) associated with a scheduled job 766 # orderBy: Provide sort information. The default is to sort by 767 # createdDateTime descending. 768 # dateTimeFilter: Filter by date/time field 769 # applicationIds: Provide list of application IDs to filter jobs. 770 # Defaults to the user's own application. 771 # engineIds: Provide a list of engine IDs to filter for jobs 772 # that contain tasks for the specified engines. 773 # engineCategoryIds: Provide a list of engine category IDs to 774 # filter for jobs 775 # that contain tasks for engines in the specific categories. 776 ( 777 Boolean, : 778 ID, : 779 JobStatusFilter!], : [ 780 String, : 781 Int, : 782 Int, : 783 ID, : 784 ID, : 785 ID, : 786 ID!], : [ 787 Boolean, : 788 JobSortField!], : [ 789 JobDateTimeFilter!], : [ 790 ID], : [ 791 ID!], : [ 792 ID!] : [ 793 ): JobList 794 795 # Retrieve a single job by ID 796 # 797 # Arguments 798 # id: the job ID. 799 ID!): Job ( : 800 801 # Retrieve a single task by ID 802 # 803 # Arguments 804 # id: Provide the task ID. 805 ID!): Task ( : 806 807 # Retrieve entity identifier types 808 # Example: 809 # Request: 810 # query { 811 # 812 # entityIdentifierTypes(limit:2) { 813 # 814 # records{ 815 # 816 # id 817 # 818 # label 819 # 820 # } 821 # 822 # } 823 # } 824 # Response: 825 # { 826 # 827 # "data": { 828 # 829 # "entityIdentifierTypes": { 830 # 831 # "records": [ 832 # 833 # { 834 # 835 # "id": "face", 836 # 837 # "label": "Face" 838 # 839 # }, 840 # 841 # { 842 # 843 # "id": "audio-recording", 844 # 845 # "label": "audio file" 846 # 847 # } 848 # 849 # ] 850 # 851 # } 852 # 853 # } 854 # } 855 # 856 # Arguments 857 # id: Provide an ID to retrieve a single specific entity 858 # identifier type. 859 # offset: Provide an offset to skip to a certain element in the 860 # result, for paging. 861 # limit: Specify maximum number of results to retrieve in this 862 # result. Page size. 863 ID, : Int, : Int): EntityIdentifierTypeList ( : 864 865 # Retrieve an entity identifier type 866 # Example: 867 # Request: 868 # query { 869 # 870 # entityIdentifierType(id:"face") { 871 # 872 # label 873 # 874 # entityIdentifierItems { 875 # 876 # libraryTypeId 877 # 878 # } 879 # 880 # } 881 # } 882 # Response: 883 # { 884 # 885 # "data": { 886 # 887 # "entityIdentifierType": { 888 # 889 # "label": "Face", 890 # 891 # "entityIdentifierItems": [ 892 # 893 # { 894 # 895 # "libraryTypeId": "people" 896 # 897 # }, 898 # 899 # { 900 # 901 # "libraryTypeId": "suspect" 902 # 903 # }, 904 # 905 # { 906 # 907 # "libraryTypeId": "people-known-offender" 908 # 909 # }, 910 # 911 # { 912 # 913 # "libraryTypeId": "people-of-interest" 914 # 915 # } 916 # 917 # ] 918 # 919 # } 920 # 921 # } 922 # } 923 # 924 # Arguments 925 # id: Provide the entity identifier type ID 926 ID!): EntityIdentifierType ( : 927 928 # Retrieve all library types 929 # Example: 930 # Request: 931 # query { 932 # 933 # libraryTypes(limit:2) { 934 # 935 # records{ 936 # 937 # id 938 # 939 # entityTypeName 940 # 941 # } 942 # 943 # } 944 # } 945 # Response: 946 # { 947 # 948 # "data": { 949 # 950 # "libraryTypes": { 951 # 952 # "records": [ 953 # 954 # { 955 # 956 # "id": "people-known-offender", 957 # 958 # "entityTypeName": "known offender" 959 # 960 # }, 961 # 962 # { 963 # 964 # "id": "dataset", 965 # 966 # "entityTypeName": "dataset" 967 # 968 # } 969 # 970 # ] 971 # 972 # } 973 # 974 # } 975 # } 976 # 977 # Arguments 978 # id: Provide an ID to retrieve a single specific library type. 979 # offset: Provide an offset to skip to a certain element in the 980 # result, for paging. 981 # limit: Specify maximum number of results to retrieve in this 982 # result. Page size. 983 ID, : Int, : Int): LibraryTypeList ( : 984 985 # Retrieve a single library type 986 # Example: 987 # Request: 988 # query { 989 # 990 # libraryType(id: "people-known-offender") { 991 # 992 # entityTypeName 993 # 994 # label 995 # 996 # } 997 # } 998 # Response: 999 # { 1000 # 1001 # "data": { 1002 # 1003 # "libraryType": { 1004 # 1005 # "entityTypeName": "known offender", 1006 # 1007 # "label": "IDentify - Known Offender" 1008 # 1009 # } 1010 # 1011 # } 1012 # } 1013 # 1014 # Arguments 1015 # id: Provide an ID to retrieve a single specific library type. 1016 ID): LibraryType ( : 1017 1018 # Retrieve libraries and entities 1019 # Example: 1020 # Request: 1021 # query { 1022 # 1023 # libraries(limit:2) { 1024 # 1025 # records { 1026 # 1027 # id 1028 # 1029 # name 1030 # 1031 # libraryTypeId 1032 # 1033 # } 1034 # 1035 # } 1036 # } 1037 # Response: 1038 # { 1039 # 1040 # "data": { 1041 # 1042 # "libraries": { 1043 # 1044 # "records": [ 1045 # 1046 # { 1047 # 1048 # "id": "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599", 1049 # 1050 # "name": "example", 1051 # 1052 # "libraryTypeId": "123" 1053 # 1054 # } 1055 # 1056 # ] 1057 # 1058 # } 1059 # 1060 # } 1061 # } 1062 # 1063 # Arguments 1064 # id: Provide an ID to retrieve a single specific library. 1065 # name: Provide a name string to search by name. 1066 # type: Provide the name or ID of a library to search for 1067 # libraries 1068 # that contain that type. 1069 # entityIdentifierTypeIds: Provide the id of an entity identifier 1070 # type to search for libraries that correlate 1071 # to that type. 1072 # includeOwnedOnly: Specify true if only libraries owned by the 1073 # user's organization 1074 # should be returned. Otherwise, shared libraries will be included. 1075 # offset: Provide an offset to skip to a certain element in the 1076 # result, for paging. 1077 # limit: Specify maximum number of results to retrieve in this 1078 # result. Page size. 1079 # orderBy: Specify a field to order by 1080 # orderDirection: Specify the direction to order by 1081 ( 1082 ID, : 1083 String, : 1084 String, : 1085 String!], : [ 1086 Boolean, : 1087 Int, : 1088 Int, : 1089 LibraryOrderBy, : 1090 OrderDirection : 1091 ): LibraryList 1092 1093 # Retrieve a specific library 1094 # Example: 1095 # Request: 1096 # query { 1097 # 1098 # library(id: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599") { 1099 # 1100 # name 1101 # 1102 # organizationId 1103 # 1104 # } 1105 # } 1106 # Response: 1107 # { 1108 # 1109 # "data": { 1110 # 1111 # "library": { 1112 # 1113 # "name": "example", 1114 # 1115 # "organizationId": "35521" 1116 # 1117 # } 1118 # 1119 # } 1120 # } 1121 # 1122 # Arguments 1123 # id: Provide a library ID. 1124 ID!): Library ( : 1125 1126 # Retrieve a specific library engine model 1127 # Example: 1128 # Request: 1129 # query { 1130 # 1131 # libraryEngineModel(id: "87714ca6-8dbd-4da0-9dc0-d9233927b00d") { 1132 # 1133 # trainStatus 1134 # 1135 # engineId 1136 # 1137 # } 1138 # } 1139 # Response: 1140 # { 1141 # 1142 # "data": { 1143 # 1144 # "libraryEngineModel": { 1145 # 1146 # "trainStatus": "pending", 1147 # 1148 # "engineId": "1" 1149 # 1150 # } 1151 # 1152 # } 1153 # } 1154 # 1155 # Arguments 1156 # id: Provide the library engine model ID 1157 ID!): LibraryEngineModel ( : 1158 1159 # Retrieve a specific entity 1160 # Example: 1161 # Request: 1162 # query { 1163 # 1164 # entity(id: "85b700fa-f327-4fea-b94b-ed83054170db") { 1165 # 1166 # name 1167 # 1168 # libraryId 1169 # 1170 # isPublished 1171 # 1172 # } 1173 # } 1174 # Response: 1175 # { 1176 # 1177 # "data": { 1178 # 1179 # "entity": { 1180 # 1181 # "name": "example", 1182 # 1183 # "libraryId": "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599", 1184 # 1185 # "isPublished": false 1186 # 1187 # } 1188 # 1189 # } 1190 # } 1191 # 1192 # Arguments 1193 # id: Provide an entity ID. 1194 ID!): Entity ( : 1195 1196 # Retrieve a list of entities across libraries 1197 # Example: 1198 # Request: 1199 # query { 1200 # 1201 # entities(libraryIds: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599") { 1202 # 1203 # records { 1204 # 1205 # id 1206 # 1207 # name 1208 # 1209 # isPublished 1210 # 1211 # } 1212 # 1213 # } 1214 # } 1215 # Response: 1216 # { 1217 # 1218 # "data": { 1219 # 1220 # "entities": { 1221 # 1222 # "records": [ 1223 # 1224 # { 1225 # 1226 # "id": "85b700fa-f327-4fea-b94b-ed83054170db", 1227 # 1228 # "name": "example", 1229 # 1230 # "isPublished": false 1231 # 1232 # } 1233 # 1234 # ] 1235 # 1236 # } 1237 # 1238 # } 1239 # } 1240 # 1241 # Arguments 1242 # ids: Provide a list of entity IDs to retrieve those entities 1243 # libraryIds: Provide a list of library IDs to retrieve entities 1244 # across 1245 # multiple libraries. 1246 ( 1247 ID!], : [ 1248 ID!], : [ 1249 Boolean, : 1250 ID, : 1251 String, : 1252 Int, : 1253 Int, : 1254 LibraryEntityOrderBy, : 1255 OrderDirection : 1256 ): EntityList 1257 1258 # Retrieve library configuration 1259 # Example: 1260 # Request: 1261 # query { 1262 # 1263 # libraryConfiguration(id:"7396e71b-db5a-4c4c-bf6f-4fc66a5a07f7") { 1264 # 1265 # confidence{ 1266 # 1267 # min 1268 # 1269 # max 1270 # 1271 # } 1272 # 1273 # } 1274 # } 1275 # Response: 1276 # { 1277 # 1278 # "data": { 1279 # 1280 # "libraryConfiguration": { 1281 # 1282 # "confidence": { 1283 # 1284 # "min": 0, 1285 # 1286 # "max": 100 1287 # 1288 # } 1289 # 1290 # } 1291 # 1292 # } 1293 # } 1294 # 1295 # Arguments 1296 # id: Provide configuration id 1297 ID!): LibraryConfiguration ( : 1298 1299 # Retrieve applications. These are custom applications integrated into 1300 # the Veritone platform using the VDA framework. 1301 # Example: 1302 # Request: 1303 # query { 1304 # 1305 # applications(limit:2) { 1306 # 1307 # records { 1308 # 1309 # id 1310 # 1311 # name 1312 # 1313 # } 1314 # 1315 # } 1316 # } 1317 # Response: 1318 # { 1319 # 1320 # "data": { 1321 # 1322 # "applications": { 1323 # 1324 # "records": [ 1325 # 1326 # { 1327 # 1328 # "id": "47bd3e25-f4ea-435f-b69b-13cb4f9dd60a", 1329 # 1330 # "name": "appexamplebill" 1331 # 1332 # }, 1333 # 1334 # { 1335 # 1336 # "id": "5908703b-51b4-4291-9787-b54bada73b0a", 1337 # 1338 # "name": "appexample2" 1339 # 1340 # } 1341 # 1342 # ] 1343 # 1344 # } 1345 # 1346 # } 1347 # } 1348 # 1349 # Arguments 1350 # id: Provide an ID to retrieve a single specific application. 1351 # status: Provide a status, such as "draft" or "active" 1352 # owned: If true, return only applications owned by the user's 1353 # organization. 1354 # orgId: For super admin user only, if specified, the query 1355 # returns applications for this orgId. 1356 # isPublic: Filter applications that are public 1357 # excludeViewOnly: Include package grantType==VIEW 1358 # filter: Filters for application attributes 1359 # offset: Provide an offset to skip to a certain element in the 1360 # result, for paging. 1361 # limit: Specify maximum number of results to retrieve in this 1362 # result. Page size. 1363 # orderBy: Provide a list of ApplicationSortField to sort by. 1364 # accessScope: Specify one or more access scopes to filter by 1365 # accessible applications 1366 ( 1367 ID, : 1368 ApplicationStatus, : 1369 Boolean, : 1370 ID, : 1371 Boolean, : 1372 Boolean, : 1373 ApplicationFilter, : 1374 Int, : 1375 Int, : 1376 ApplicationSortField], : [ 1377 AccessScope!] : [ 1378 ): ApplicationList 1379 1380 # Retrieve organizations 1381 # Example: 1382 # Request: 1383 # query { 1384 # 1385 # organizations(limit:2) { 1386 # 1387 # records { 1388 # 1389 # id 1390 # 1391 # name 1392 # 1393 # } 1394 # 1395 # } 1396 # } 1397 # Response: 1398 # { 1399 # 1400 # "data": { 1401 # 1402 # "organizations": { 1403 # 1404 # "records": [ 1405 # 1406 # { 1407 # 1408 # "id": "35521", 1409 # 1410 # "name": "WTS API Docs Org" 1411 # 1412 # } 1413 # 1414 # ] 1415 # 1416 # } 1417 # 1418 # } 1419 # } 1420 # 1421 # Arguments 1422 # id: Provide an ID to retrieve a single specific organization. 1423 # offset: Provide an offset to skip to a certain element in the 1424 # result, for paging. 1425 # limit: Specify maximum number of results to retrieve in this 1426 # result. Page size. 1427 # kvpProperty: Provide a property from the organization kvp to 1428 # filter the organization list. 1429 # kvpValue: Provide value to for the kvpFeature filter. 1430 # If not present the filter becomes kvpProperty existence filter 1431 # name: Optionally, supply a string for string match 1432 # nameMatch: Supply the type of string match to apply. 1433 ( 1434 ID, : 1435 Int, : 1436 Int, : 1437 String, : 1438 String, : 1439 String, : 1440 StringMatch, : 1441 Boolean : 1442 ): OrganizationList 1443 1444 # Retrieve a single organization 1445 # Example: 1446 # Request: 1447 # query { 1448 # 1449 # organization(id: "35521") { 1450 # 1451 # status 1452 # 1453 # } 1454 # } 1455 # Response: 1456 # { 1457 # 1458 # "data": { 1459 # 1460 # "organization": { 1461 # 1462 # "status": "active" 1463 # 1464 # } 1465 # 1466 # } 1467 # } 1468 # 1469 # Arguments 1470 # id: The organization ID 1471 # TODO take application ID as well as org ID 1472 ID!): Organization ( : 1473 1474 # Retrieve basic organization info about the organizations to which the user 1475 # belongs 1476 # Example: 1477 # Request: 1478 # query { 1479 # 1480 # myOrganizations { 1481 # 1482 # records { 1483 # 1484 # id 1485 # 1486 # name 1487 # 1488 # } 1489 # 1490 # } 1491 # } 1492 # Response: 1493 # { 1494 # 1495 # "data": { 1496 # 1497 # "myOrganizations": { 1498 # 1499 # "records": [ 1500 # 1501 # { 1502 # 1503 # "id": "35521", 1504 # 1505 # "name": "WTS API Docs Org" 1506 # 1507 # } 1508 # 1509 # ] 1510 # 1511 # } 1512 # 1513 # } 1514 # } 1515 # 1516 # Arguments 1517 # offset: Provide an offset to skip to a certain element in the 1518 # result, for paging. 1519 # limit: Specify maximum number of results to retrieve in this 1520 # result. Page size. 1521 # status: Filter by organization status 1522 ( 1523 Int, : 1524 Int, : 1525 OrganizationStatus, : 1526 String : 1527 ): OrganizationInfoList 1528 1529 # Retrieve the login configuration for an organization 1530 # Example: 1531 # Request: 1532 # query { 1533 # 1534 # loginConfiguration(slug: "my-organization") { 1535 # 1536 # organizationInfo { 1537 # 1538 # id 1539 # 1540 # name 1541 # 1542 # } 1543 # 1544 # } 1545 # } 1546 # Response: 1547 # { 1548 # 1549 # "data": { 1550 # 1551 # "loginConfiguration": { 1552 # 1553 # "organizationInfo": { 1554 # 1555 # "id": "12345", 1556 # 1557 # "name": "My Organization" 1558 # 1559 # } 1560 # 1561 # } 1562 # 1563 # } 1564 # } 1565 # 1566 # Arguments 1567 # slug: The login slug associated with the login configuration 1568 # for an organization 1569 String!): LoginConfiguration ( : 1570 1571 # Retrieve all login configurations for the Instance 1572 # Example: 1573 # Request: 1574 # query { 1575 # 1576 # instanceLoginConfigurations { 1577 # 1578 # records { 1579 # 1580 # slug 1581 # 1582 # } 1583 # 1584 # } 1585 # } 1586 # Response: 1587 # { 1588 # 1589 # "data": { 1590 # 1591 # "instanceLoginConfigurations": { 1592 # 1593 # records: [ 1594 # 1595 # { 1596 # 1597 # "slug": "instance-slug", 1598 # 1599 # }, 1600 # 1601 # { 1602 # 1603 # "slug": "other-instance-slug", 1604 # 1605 # } 1606 # 1607 # ] 1608 # 1609 # } 1610 # 1611 # } 1612 # } 1613 # 1614 # Arguments 1615 # offset: Provide an offset to skip to a certain element in the 1616 # result, for paging. 1617 # limit: Specify maximum number of results to retrieve in this 1618 # result. Page size. 1619 Int, : Int): LoginConfigurationList ( : 1620 1621 # Retrieve permissions 1622 # Example: 1623 # Request: 1624 # query { 1625 # 1626 # permissions(limit:5) { 1627 # 1628 # records { 1629 # 1630 # id 1631 # 1632 # name 1633 # 1634 # } 1635 # 1636 # } 1637 # } 1638 # 1639 # Response: 1640 # { 1641 # 1642 # "data": { 1643 # 1644 # "permissions": { 1645 # 1646 # "records": [ 1647 # 1648 # { 1649 # 1650 # "id": "2", 1651 # 1652 # "name": "admin.access" 1653 # 1654 # }, 1655 # 1656 # { 1657 # 1658 # "id": "9", 1659 # 1660 # "name": "admin.group.create" 1661 # 1662 # }, 1663 # 1664 # { 1665 # 1666 # "id": "12", 1667 # 1668 # "name": "admin.group.delete" 1669 # 1670 # }, 1671 # 1672 # { 1673 # 1674 # "id": "10", 1675 # 1676 # "name": "admin.group.read" 1677 # 1678 # }, 1679 # 1680 # { 1681 # 1682 # "id": "11", 1683 # 1684 # "name": "admin.group.update" 1685 # 1686 # } 1687 # 1688 # ] 1689 # 1690 # } 1691 # 1692 # } 1693 # } 1694 # 1695 # Arguments 1696 # id: Provide an ID to retrieve a single specific permission. 1697 # offset: Provide an offset to skip to a certain element in the 1698 # result, for paging. 1699 # limit: Specify maximum number of results to retrieve in this 1700 # result. Page size. 1701 ID, : String, : Int, : Int): PermissionList ( : 1702 1703 # Retrieve users 1704 # Example: 1705 # Request: 1706 # query { 1707 # 1708 # users( 1709 # 1710 # organizationIds:"35521", 1711 # 1712 # limit: 2) { 1713 # 1714 # records { 1715 # 1716 # id 1717 # 1718 # name 1719 # 1720 # } 1721 # 1722 # } 1723 # } 1724 # Response: 1725 # { 1726 # 1727 # "data": { 1728 # 1729 # "users": { 1730 # 1731 # "records": [ 1732 # 1733 # { 1734 # 1735 # "id": "267de7e1-efb2-444a-a524-210328b78503", 1736 # 1737 # "name": "example" 1738 # 1739 # }, 1740 # 1741 # { 1742 # 1743 # "id": "d8304ba1-0d4c-4268-a82c-8c62fd455066", 1744 # 1745 # "name": "example1" 1746 # 1747 # } 1748 # 1749 # ] 1750 # 1751 # } 1752 # 1753 # } 1754 # } 1755 # 1756 # Arguments 1757 # id: Provide an ID to retrieve a single specific user. 1758 # A user ID is a string in UUID format. 1759 # ids: Provide IDs to retrieve multiple users by ID. 1760 # name: Provide a name, or part of one, to search by name. 1761 # organizationIds: Provide a list of organization IDs to filter 1762 # your search by organization. 1763 # offset: Provide an offset to skip to a certain element in the 1764 # result, for paging. 1765 # limit: Specify maximum number of results to retrieve in this 1766 # result. Page size. 1767 # includeAllOrgUsers: Include all organization users. 1768 # dateTimeFilter: Filter by date/time field 1769 # status: Filter by account status 1770 # roleIds: Filter by application roles 1771 ( 1772 ID, : 1773 ID], : [ 1774 String, : 1775 ID], : [ 1776 Int, : 1777 Int, : 1778 Boolean, : 1779 UsersDateTimeFilter!], : [ 1780 UserStatus, : 1781 ID] : [ 1782 ): UserList 1783 1784 # Retrieve an individual user 1785 # Example: 1786 # Request: 1787 # query { 1788 # 1789 # user(id: "267de7e1-efb2-444a-a524-210328b78503") { 1790 # 1791 # name 1792 # 1793 # status 1794 # 1795 # } 1796 # } 1797 # Response: 1798 # { 1799 # 1800 # "data": { 1801 # 1802 # "user": { 1803 # 1804 # "name": "example", 1805 # 1806 # "status": "deleted" 1807 # 1808 # } 1809 # 1810 # } 1811 # } 1812 # 1813 # Arguments 1814 # id: The user ID. 1815 # A user ID is a string in UUID format. 1816 ID!, : [ID]): User ( : 1817 1818 # Retrieve user's organization API tokens 1819 # Example: 1820 # Request: 1821 # query { 1822 # 1823 # tokens { 1824 # 1825 # id 1826 # 1827 # applicationId 1828 # 1829 # } 1830 # } 1831 # Response: 1832 # { 1833 # 1834 # "data": { 1835 # 1836 # "tokens": [] 1837 # 1838 # } 1839 # } 1840 Token] : [ 1841 1842 # Retrieve information for the current logged-in user 1843 # Example: 1844 # Request: 1845 # query { 1846 # 1847 # me { 1848 # 1849 # id 1850 # 1851 # organizationId 1852 # 1853 # } 1854 # } 1855 # Response: 1856 # { 1857 # 1858 # "data": { 1859 # 1860 # "me": { 1861 # 1862 # "id": "59cb4e74-7c31-4267-b91e-d4600bc08008", 1863 # 1864 # "organizationId": "35521" 1865 # 1866 # } 1867 # 1868 # } 1869 # } 1870 User : 1871 1872 # Retrieve groups 1873 # Example: 1874 # Request: 1875 # query { 1876 # 1877 # groups { 1878 # 1879 # records { 1880 # 1881 # id 1882 # 1883 # name 1884 # 1885 # } 1886 # 1887 # } 1888 # } 1889 # Response: 1890 # { 1891 # 1892 # "data": { 1893 # 1894 # "groups": { 1895 # 1896 # "records": [ 1897 # 1898 # { 1899 # 1900 # "id": "8db639c1-c926-4f83-90de-d86c2ae5973d", 1901 # 1902 # "name": "WTS API Docs Org" 1903 # 1904 # } 1905 # 1906 # ] 1907 # 1908 # } 1909 # 1910 # } 1911 # } 1912 # 1913 # Arguments 1914 # id: Provide an ID to retrieve a specific group by ID 1915 # ids: Provide IDs to retrieve multiple groups by ID 1916 # name: Provide a name, or part of one, to search for groups by 1917 # name 1918 # organizationIds: " 1919 # Provide a list of organization IDs to retrieve groups defined 1920 # within certain organizations. 1921 # offset: Provide an offset to skip to a certain element in the 1922 # result, for paging. 1923 # limit: Specify maximum number of results to retrieve in this 1924 # result. Page size. 1925 ID, : [ID], : String, : [ID], : Int, : Int): GroupList ( : 1926 1927 # Retrieve a single mention 1928 # 1929 # Arguments 1930 # mentionId: The mention ID 1931 # limit: Comments pagination - limit 1932 # offset: Comments pagination - limit 1933 # userId: The user who owns the mention. 1934 ID!, : Int, : Int, : String): Mention ( : 1935 1936 # Retrieve a shared mention 1937 # 1938 # Arguments 1939 # shareId: share token 1940 ID!): SharedMention ( : 1941 1942 # Search for mentions across an index. 1943 # This query requires a user token. 1944 # Known Issues: 1945 # - Offset can not go past 10,000. To get around this, the best practice is to 1946 # keep updating the start time of the query based on the last mention you have 1947 # processed. 1948 # Example: 1949 # Request: 1950 # query{ 1951 # 1952 # searchMentions(search:{ 1953 # 1954 # offset: 0 1955 # 1956 # limit: 1 1957 # 1958 # index: ["mine"] 1959 # 1960 # query:{ 1961 # 1962 # operator: "and" 1963 # 1964 # conditions: [{ 1965 # 1966 # operator: "term" 1967 # 1968 # field: "trackingUnitName" 1969 # 1970 # value: "Dallas Cowboys Super Bowl" 1971 # 1972 # }, 1973 # 1974 # { 1975 # 1976 # operator: "term" 1977 # 1978 # field: "mentionStatusId" 1979 # 1980 # value: "1" 1981 # 1982 # }] 1983 # 1984 # } 1985 # 1986 # }) { 1987 # 1988 # jsondata 1989 # 1990 # } 1991 # } 1992 # Response: 1993 # { 1994 # 1995 # "data": { 1996 # 1997 # "searchMentions": { 1998 # 1999 # "jsondata": { 2000 # 2001 # "results": [ 2002 # 2003 # { 2004 # 2005 # "id": 47569938, 2006 # 2007 # "programFormatName": "Information and News", 2008 # 2009 # "mentionDate": "2017-01-31T07:59:18.000Z", 2010 # 2011 # "mediaStartTime": "2017-01-31T07:45:01.000Z", 2012 # 2013 # "mediaId": 20017455, 2014 # 2015 # "metadata": { 2016 # 2017 # "filename": "AM-RADIO", 2018 # 2019 # "veritone-file": { 2020 # 2021 # "size": 0, 2022 # 2023 # "filename": "AM-RADIO", 2024 # 2025 # "mimetype": "audio/mpeg" 2026 # 2027 # }, 2028 # 2029 # "veritone-media-source": { 2030 # 2031 # "mediaSourceId": "14326", 2032 # 2033 # "mediaSourceTypeId": "1" 2034 # 2035 # }, 2036 # 2037 # "veritone-program": { 2038 # 2039 # "programId": "3828", 2040 # 2041 # "programName": "AM-RADIO Morning Talk", 2042 # 2043 # "programImage": 2044 # "https://s3.amazonaws.com/veritone-ugc/cb5e59d4-a986-4e2b-b525-482319df3350%2FbrdProgram%2F2uGsLVKsQeiKN3UuHufC_941478_10151455644772706_951533539_n.jpg", 2045 # 2046 # "programLiveImage": 2047 # "https://s3.amazonaws.com/prod-veritone-ugc/cb5e59d4-a986-4e2b-b525-482319df3350%2FbrdProgram%2FwwEn3Ya9RgmMQwUEGoD1_LUkKlgZQS36ncUbY8Iz7_2520to%2520live2.JPG" 2048 # 2049 # } 2050 # 2051 # }, 2052 # 2053 # "fileLocation": 2054 # "https://inspirent.s3.amazonaws.com/recordings/9605ea97-87df-428e-6740-720df8b8691c_original.mp3?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAI7L6G7PCOOOLA7MQ%2F20171215%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20171215T205111Z&X-Amz-Expires=604800&X-Amz-Signature=00f62a6e2367c109320c98b9aea190cd28d82ac347eeeca030f42810b7ab75e3&X-Amz-SignedHeaders=host", 2055 # 2056 # "fileType": "audio/mpeg", 2057 # 2058 # "snippets": [ 2059 # 2060 # { 2061 # 2062 # "startTime": 857.62, 2063 # 2064 # "endTime": 887.33, 2065 # 2066 # "text": "eighty first women's Australian Open final Monica Seles beat Steffi 2067 # Graf four six six three six two in one thousand nine hundred twenty eight the 2068 # Dallas Cowboys beat the Buffalo Bills thirty to thirteen in Atlanta running back 2069 # Emmitt Smith wins the M.V.P. and fourth consecutive Super Bowl game loss to the 2070 # Cowboys twenty sixteen at the one hundred fourth women's Australian Open final 2071 # six three six six four that time capsule your", 2072 # 2073 # "hits": [ 2074 # 2075 # { 2076 # 2077 # "startTime": 865.7, 2078 # 2079 # "endTime": 865.929, 2080 # 2081 # "queryTerm": "Dallas" 2082 # 2083 # }, 2084 # 2085 # { 2086 # 2087 # "startTime": 865.93, 2088 # 2089 # "endTime": 866.07, 2090 # 2091 # "queryTerm": "Cowboys" 2092 # 2093 # }, 2094 # 2095 # { 2096 # 2097 # "startTime": 872.74, 2098 # 2099 # "endTime": 873.31, 2100 # 2101 # "queryTerm": "Super" 2102 # 2103 # }, 2104 # 2105 # { 2106 # 2107 # "startTime": 873.31, 2108 # 2109 # "endTime": 873.43, 2110 # 2111 # "queryTerm": "Bowl" 2112 # 2113 # } 2114 # 2115 # ] 2116 # 2117 # } 2118 # 2119 # ], 2120 # 2121 # "userSnippets": null, 2122 # 2123 # "advertiserId": 0, 2124 # 2125 # "advertiserName": "", 2126 # 2127 # "brandId": 0, 2128 # 2129 # "brandImage": "", 2130 # 2131 # "brandName": "", 2132 # 2133 # "campaignId": 0, 2134 # 2135 # "campaignName": "", 2136 # 2137 # "organizationId": 7295, 2138 # 2139 # "organizationName": "Demo Organization", 2140 # 2141 # "trackingUnitId": 10032, 2142 # 2143 # "trackingUnitName": "Dallas Cowboys Super Bowl", 2144 # 2145 # "mentionStatusId": 1, 2146 # 2147 # "mediaSourceTypeId": 1, 2148 # 2149 # "mediaSourceTypeName": "Audio", 2150 # 2151 # "mediaSourceId": 14326, 2152 # 2153 # "mediaSourceName": "AM-RADIO Morning Talk", 2154 # 2155 # "isNational": true, 2156 # 2157 # "spotTypeId": null, 2158 # 2159 # "spotTypeName": null, 2160 # 2161 # "programId": 3828, 2162 # 2163 # "programName": "AM-RADIO", 2164 # 2165 # "programImage": 2166 # "https://s3.amazonaws.com/prod-veritone-ugc/cb5e59d4-a986-4e2b-b525-482319df3350%2FbrdProgram%2F2uGsLVKsQeiKN3UuHufC_941478_10151455644772706_951533539_n.jpg", 2167 # 2168 # "programLiveImage": 2169 # "https://s3.amazonaws.com/veritone-ugc/cb5e52b4-a986-4e2b-b525-482319df3350%2FbrdProgram%2FwwEn3Ya9RgmMQwUEGoD1_LUkKlgZQS36ncUbY8Iz7_2520to%2520live2.JPG", 2170 # 2171 # "impressions": 1894, 2172 # 2173 # "audience": [ 2174 # 2175 # { 2176 # 2177 # "gender": "men", 2178 # 2179 # "age_group": "35-44", 2180 # 2181 # "audience": 11, 2182 # 2183 # "isTargetMatch": true 2184 # 2185 # }, 2186 # 2187 # { 2188 # 2189 # "gender": "men", 2190 # 2191 # "age_group": "45-49", 2192 # 2193 # "audience": 121, 2194 # 2195 # "isTargetMatch": true 2196 # 2197 # }, 2198 # 2199 # { 2200 # 2201 # "gender": "men", 2202 # 2203 # "age_group": "50-54", 2204 # 2205 # "audience": 474, 2206 # 2207 # "isTargetMatch": true 2208 # 2209 # }, 2210 # 2211 # { 2212 # 2213 # "gender": "men", 2214 # 2215 # "age_group": "65+", 2216 # 2217 # "audience": 95, 2218 # 2219 # "isTargetMatch": true 2220 # 2221 # }, 2222 # 2223 # { 2224 # 2225 # "gender": "women", 2226 # 2227 # "age_group": "50-54", 2228 # 2229 # "audience": 19, 2230 # 2231 # "isTargetMatch": false 2232 # 2233 # }, 2234 # 2235 # { 2236 # 2237 # "gender": "women", 2238 # 2239 # "age_group": "65+", 2240 # 2241 # "audience": 693, 2242 # 2243 # "isTargetMatch": false 2244 # 2245 # }, 2246 # 2247 # { 2248 # 2249 # "gender": "men", 2250 # 2251 # "age_group": "55-64", 2252 # 2253 # "audience": 481, 2254 # 2255 # "isTargetMatch": true 2256 # 2257 # } 2258 # 2259 # ], 2260 # 2261 # "targetAudience": { 2262 # 2263 # "gender": 1, 2264 # 2265 # "genderName": "M", 2266 # 2267 # "ageGroup": [ 2268 # 2269 # 0, 2270 # 2271 # 5 2272 # 2273 # ], 2274 # 2275 # "ageGroupMin": 18, 2276 # 2277 # "ageGroupMax": 0, 2278 # 2279 # "impressions": 1182 2280 # 2281 # }, 2282 # 2283 # "audienceMarketCount": 3, 2284 # 2285 # "audienceAffiliateCount": 1, 2286 # 2287 # "rating": null, 2288 # 2289 # "ratings": null, 2290 # 2291 # "comments": null, 2292 # 2293 # "markets": [ 2294 # 2295 # { 2296 # 2297 # "marketId": 54, 2298 # 2299 # "marketName": "Des Moines-Ames, IA" 2300 # 2301 # } 2302 # 2303 # ], 2304 # 2305 # "marketId": null, 2306 # 2307 # "marketName": null, 2308 # 2309 # "hourOfDay": 7, 2310 # 2311 # "dayOfWeek": 2, 2312 # 2313 # "dayOfMonth": 31, 2314 # 2315 # "month": 1, 2316 # 2317 # "year": 2017, 2318 # 2319 # "isMatch": true, 2320 # 2321 # "mentionStatusName": "Pending Verification", 2322 # 2323 # "complianceStatusId": null, 2324 # 2325 # "cognitiveEngineResults": null, 2326 # 2327 # "hits": 4 2328 # 2329 # } 2330 # 2331 # ], 2332 # 2333 # "totalResults": 579, 2334 # 2335 # "limit": 1, 2336 # 2337 # "from": 0, 2338 # 2339 # "to": 0, 2340 # 2341 # "searchToken": "ae882400-e1d9-11e7-947b-339cddca931e", 2342 # 2343 # "timestamp": 1513371071 2344 # 2345 # } 2346 # 2347 # } 2348 # 2349 # } 2350 # } 2351 # 2352 # Arguments 2353 # search: JSON structure containing the search query. 2354 # See https://docs.veritone.com/#/apis/search-quickstart for full details on the 2355 # search query syntax 2356 JSONData!): SearchResult ( : 2357 2358 # Search for media across an index. 2359 # This query requires a user token. 2360 # Example: 2361 # Request: 2362 # query{ 2363 # 2364 # searchMedia(search:{ 2365 # 2366 # offset: 0 2367 # 2368 # limit: 1 2369 # 2370 # index: ["mine"] 2371 # 2372 # query:{ 2373 # 2374 # operator: "query_string" 2375 # 2376 # field: "transcript.transcript" 2377 # 2378 # value: "paris NOT \"las vegas\"" 2379 # 2380 # } 2381 # 2382 # }) { 2383 # 2384 # jsondata 2385 # 2386 # } 2387 # } 2388 # Response: 2389 # { 2390 # 2391 # "data": { 2392 # 2393 # "searchMedia": { 2394 # 2395 # "jsondata": { 2396 # 2397 # "results": [ 2398 # 2399 # { 2400 # 2401 # "recording": { 2402 # 2403 # "recordingId": "43033727", 2404 # 2405 # "fileLocation": 2406 # "https://inspirent.s3.amazonaws.com/assets/43033727/ea9d9845-775b-48cd-aada-16fa56894ba0.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAI7L6G7PCOOOLA7MQ%2F20171215%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20171215T181255Z&X-Amz-Expires=604800&X-Amz-Signature=2fd918d5ac20979bd27d365bfa455904cf1726307fddbd362a28a8bd9a0a81a8&X-Amz-SignedHeaders=host", 2407 # 2408 # "fileType": "video/mp4", 2409 # 2410 # "programId": "-1", 2411 # 2412 # "programName": "Weekly Talkshow", 2413 # 2414 # "programLiveImage": 2415 # "https://inspirent.s3.amazonaws.com/assets/43033727/fe693b30-18ae-47c7-984f-530eab61d7.jpeg", 2416 # 2417 # "mediaSourceId": "-1", 2418 # 2419 # "mediaSourceTypeId": "5", 2420 # 2421 # "sliceTime": 1512682022, 2422 # 2423 # "mediaStartTime": 1512681992, 2424 # 2425 # "aibDuration": 90, 2426 # 2427 # "isOwn": true, 2428 # 2429 # "hitStartTime": 1512682022, 2430 # 2431 # "hitEndTime": 1512682082 2432 # 2433 # }, 2434 # 2435 # "startDateTime": 1512682022, 2436 # 2437 # "stopDateTime": 1512682082, 2438 # 2439 # "hits": [ 2440 # 2441 # { 2442 # 2443 # "veritone-file": { 2444 # 2445 # "filename": "Veritone_v06.mp4", 2446 # 2447 # "mimetype": "video/mp4", 2448 # 2449 # "size": 162533502 2450 # 2451 # } 2452 # 2453 # } 2454 # 2455 # ] 2456 # 2457 # } 2458 # 2459 # ], 2460 # 2461 # "totalResults": 733275, 2462 # 2463 # "limit": 1, 2464 # 2465 # "from": 0, 2466 # 2467 # "to": 0, 2468 # 2469 # "searchToken": "930f0960-e1c3-11e7-9e94-eba5f6b5faf7", 2470 # 2471 # "timestamp": 1513361576 2472 # 2473 # } 2474 # 2475 # } 2476 # 2477 # } 2478 # } 2479 # 2480 # Arguments 2481 # search: JSON structure containing the search query. 2482 # See https://docs.veritone.com/#/apis/search-quickstart for full details on the 2483 # search query syntax 2484 JSONData!): SearchResult ( : 2485 2486 # Retrieve the root folders for an organization 2487 # Example: 2488 # Request: 2489 # query { 2490 # 2491 # rootFolders { 2492 # 2493 # id 2494 # 2495 # typeId 2496 # 2497 # } 2498 # } 2499 # Response: 2500 # { 2501 # 2502 # "data": { 2503 # 2504 # "rootFolders": [ 2505 # 2506 # { 2507 # 2508 # "id": "2ac28573-917a-4c4b-be91-a0ac64cbc982", 2509 # 2510 # "typeId": 4 2511 # 2512 # }, 2513 # 2514 # { 2515 # 2516 # "id": "d3e27eb3-7d4a-47ab-af64-bf1529390f4e", 2517 # 2518 # "typeId": 4 2519 # 2520 # } 2521 # 2522 # ] 2523 # 2524 # } 2525 # } 2526 # 2527 # Arguments 2528 # type: The type of root folder to retrieve 2529 RootFolderType): [Folder] ( : 2530 2531 # Retrieve a single folder. Used to navigate the folder tree structure. 2532 # Example: 2533 # Request: 2534 # query { 2535 # 2536 # folder(id: "2ac28573-917a-4c4b-be91-a0ac64cbc982") { 2537 # 2538 # typeId 2539 # 2540 # id 2541 # 2542 # childFolders{ 2543 # 2544 # records{ 2545 # 2546 # id 2547 # 2548 # } 2549 # 2550 # } 2551 # 2552 # } 2553 # } 2554 # Response: 2555 # { 2556 # 2557 # "data": { 2558 # 2559 # "folder": { 2560 # 2561 # "typeId": 4, 2562 # 2563 # "id": "3104f61f-4bd1-4175-9fe6-27436d591c54", 2564 # 2565 # "childFolders": { 2566 # 2567 # "records": [ 2568 # 2569 # { 2570 # 2571 # "id": "9d639f1b-a0d4-47b0-8149-3568f048f320" 2572 # 2573 # }, 2574 # 2575 # { 2576 # 2577 # "id": "a347319d-72da-43a2-93fc-e677876aca80" 2578 # 2579 # } 2580 # 2581 # ] 2582 # 2583 # } 2584 # 2585 # } 2586 # 2587 # } 2588 # } 2589 # 2590 # Arguments 2591 # id: Provide an ID to retrieve a single specific user. 2592 ID!): Folder ( : 2593 2594 # Retrieve the current platform information. 2595 # Example: 2596 # Request: 2597 # query { 2598 # 2599 # platformInfo { 2600 # 2601 # properties 2602 # 2603 # aiWAREVersion { 2604 # 2605 # currentVersion { 2606 # 2607 # version 2608 # 2609 # } 2610 # 2611 # previousVersion { 2612 # 2613 # version 2614 # 2615 # } 2616 # 2617 # nextVersion { 2618 # 2619 # version 2620 # 2621 # } 2622 # 2623 # } 2624 # 2625 # aiWAREVersionHistory(offset: 0, limit: 30) { 2626 # 2627 # platformVersion { 2628 # 2629 # id 2630 # 2631 # version 2632 # 2633 # } 2634 # 2635 # id 2636 # 2637 # }, 2638 # 2639 # aiWAREVersionList (orderBy: version, orderDirection: desc) { 2640 # 2641 # count 2642 # 2643 # records { 2644 # 2645 # id 2646 # 2647 # version 2648 # 2649 # } 2650 # 2651 # } 2652 # 2653 # } 2654 # } 2655 # Response: 2656 # { 2657 # 2658 # "data": { 2659 # 2660 # "platformInfo": { 2661 # 2662 # "properties": { 2663 # 2664 # "Environment": "US West", 2665 # 2666 # "ClusterSize": "small" 2667 # 2668 # } 2669 # 2670 # "aiWAREVersion": { 2671 # 2672 # "currentVersion": { 2673 # 2674 # "version": "1.1.0" 2675 # 2676 # }, 2677 # 2678 # "previousVersion": { 2679 # 2680 # "version": "1.0.0" 2681 # 2682 # }, 2683 # 2684 # "nextVersion": { 2685 # 2686 # "version": "1.2.0" 2687 # 2688 # } 2689 # 2690 # }, 2691 # 2692 # "aiWAREVersionHistory": [ 2693 # 2694 # { 2695 # 2696 # platformVersion: 2697 # 2698 # { 2699 # 2700 # "id": "c7a91281-6a1e-46d4-9f2c-7f8b4a1fc493", 2701 # 2702 # "version": "1.3.0" 2703 # 2704 # }, 2705 # 2706 # "id": "30c9c2a2-ae6a-4be2-b80c-6893d8b56780" 2707 # 2708 # }, 2709 # 2710 # { 2711 # 2712 # platformVersion: 2713 # 2714 # { 2715 # 2716 # "id": "f785bc56-2d43-472e-8629-99f9b9a5c57e", 2717 # 2718 # "version": "1.3.0" 2719 # 2720 # }, 2721 # 2722 # "id": "7b8a2ab2-00de-4f1b-9fb1-99e7a9cd108f" 2723 # 2724 # }, 2725 # 2726 # { 2727 # 2728 # platformVersion: 2729 # 2730 # { 2731 # 2732 # "id": "3c4c0b46-1a61-45ab-9f3e-b8f7a14bfaa7", 2733 # 2734 # "version": "1.3.0" 2735 # 2736 # }, 2737 # 2738 # "id": "d3499a78-efc7-4a72-a12d-852f53231e33" 2739 # 2740 # } 2741 # 2742 # ], 2743 # 2744 # "aiWAREVersionList": { 2745 # 2746 # "count": 3, 2747 # 2748 # "records": [ 2749 # 2750 # { 2751 # 2752 # "id": "799150bb-8d67-4cd1-b204-d9346e012588", 2753 # 2754 # "version": "1.0.11" 2755 # 2756 # }, 2757 # 2758 # { 2759 # 2760 # "id": "2892e80d-e0bf-4ffc-be17-4bb173d6ad29", 2761 # 2762 # "version": "1.0.2" 2763 # 2764 # }, 2765 # 2766 # { 2767 # 2768 # "id": "095b9558-6fc1-4775-9696-082b9f098c47", 2769 # 2770 # "version": "1.0.1" 2771 # 2772 # }, 2773 # 2774 # ] 2775 # 2776 # } 2777 # 2778 # } 2779 # 2780 # } 2781 # } 2782 PlatformInfo! : 2783 2784 # Example: 2785 # Request: 2786 # query { 2787 # 2788 # auditEvents(limit: 2) { 2789 # 2790 # records { 2791 # 2792 # id 2793 # 2794 # application 2795 # 2796 # } 2797 # 2798 # } 2799 # } 2800 # Response: 2801 # { 2802 # 2803 # "data": { 2804 # 2805 # "auditEvents": { 2806 # 2807 # "records": [ 2808 # 2809 # { 2810 # 2811 # "id": "fdc7b3a3-ab23-4866-a330-c0ad910cd64f", 2812 # 2813 # "application": "" 2814 # 2815 # } 2816 # 2817 # ] 2818 # 2819 # } 2820 # 2821 # } 2822 # } 2823 # 2824 # Arguments 2825 # query: An elastic query for audit events 2826 # application: Filter logs by a specific application 2827 # terms: Term filters to filter documents by properties in the 2828 # payload 2829 ( 2830 JSONData, : 2831 OrderDirection, : 2832 String, : 2833 JSONData!], : [ 2834 Int, : 2835 Int : 2836 ): AuditEventList! 2837 2838 # Retrieve a folder overview 2839 # Example: 2840 # Request: 2841 # query { 2842 # 2843 # folderOverview(ids:"3104f61f-4bd1-4175-9fe6-27436d591c54") { 2844 # 2845 # childFoldersCount 2846 # 2847 # childNonFolderObjectsCount 2848 # 2849 # } 2850 # } 2851 # Response: 2852 # { 2853 # 2854 # "data": { 2855 # 2856 # "folderOverview": { 2857 # 2858 # "childFoldersCount": 3, 2859 # 2860 # "childNonFolderObjectsCount": 0 2861 # 2862 # } 2863 # 2864 # } 2865 # } 2866 # 2867 # Arguments 2868 # ids: Tree Object Ids 2869 ID!]!, : RootFolderType): FolderOverview ( : [ 2870 2871 # Example: 2872 # Request: 2873 # query { 2874 # 2875 # folderSummaryDetails(ids: "3104f61f-4bd1-4175-9fe6-27436d591c54") { 2876 # 2877 # id 2878 # 2879 # typeId 2880 # 2881 # } 2882 # } 2883 # Response: 2884 # { 2885 # 2886 # "data": { 2887 # 2888 # "folderSummaryDetails": [ 2889 # 2890 # { 2891 # 2892 # "id": "1580701928", 2893 # 2894 # "typeId": 5 2895 # 2896 # }, 2897 # 2898 # { 2899 # 2900 # "id": "1580388995", 2901 # 2902 # "typeId": 5 2903 # 2904 # }, 2905 # 2906 # { 2907 # 2908 # "id": "2ac28573-917a-4c4b-be91-a0ac64cbc982", 2909 # 2910 # "typeId": 4 2911 # 2912 # }, 2913 # 2914 # { 2915 # 2916 # "id": "243625", 2917 # 2918 # "typeId": 3 2919 # 2920 # }, 2921 # 2922 # { 2923 # 2924 # "id": "242599", 2925 # 2926 # "typeId": 3 2927 # 2928 # }, 2929 # 2930 # { 2931 # 2932 # "id": "d551fbd6-7354-4b0e-abfb-654ab8583be2", 2933 # 2934 # "typeId": 1 2935 # 2936 # }, 2937 # 2938 # { 2939 # 2940 # "id": "a347319d-72da-43a2-93fc-e677876aca80", 2941 # 2942 # "typeId": 1 2943 # 2944 # }, 2945 # 2946 # { 2947 # 2948 # "id": "9d639f1b-a0d4-47b0-8149-3568f048f320", 2949 # 2950 # "typeId": 1 2951 # 2952 # } 2953 # 2954 # ] 2955 # 2956 # } 2957 # } 2958 # 2959 # Arguments 2960 # ids: Tree Object Ids 2961 ( 2962 ID!]!, : [ 2963 RootFolderType : 2964 ): [FolderSummaryDetail] 2965 2966 # Retrieve configs for a given application 2967 # Example: 2968 # Request: 2969 # query { 2970 # 2971 # applicationConfig(applicationId: "47bd3e25-f4ea-435f-b69b-13cb4f9dd60a") { 2972 # 2973 # records: { 2974 # 2975 # configType 2976 # 2977 # configLevel 2978 # 2979 # } 2980 # 2981 # offset: 0 2982 # 2983 # limit: 1 2984 # 2985 # } 2986 # } 2987 # Response: 2988 # { 2989 # 2990 # "data": { 2991 # 2992 # "applicationConfig": { 2993 # 2994 # "records": { 2995 # 2996 # "configType": "String", 2997 # 2998 # "configLevel": "Organization" 2999 # 3000 # } 3001 # 3002 # } 3003 # 3004 # } 3005 # } 3006 # 3007 # Arguments 3008 # orgId: Optional. Organization ID. 3009 # 3010 # If not specified, this will be the user's organization 3011 # userId: Optional. If specified, returned the configs for this 3012 # user and organization combo 3013 # includeDefaults: If true, include defaults not specified 3014 # configKeyRegexp: If specified, filter the configKey 3015 # offset: Specify maximum number of results to retrieve in this 3016 # result. Page size. 3017 # limit: Specify maximum number of results to retrieve in this 3018 # result. 3019 ( 3020 ID!, : 3021 ID, : 3022 ID, : 3023 Boolean, : 3024 String, : 3025 Int, : 3026 Int : 3027 ): ApplicationConfigList! 3028 3029 # Retrieve config definitions for a given application 3030 # Example: 3031 # Request: 3032 # query { 3033 # 3034 # applicationConfigDefinition(applicationId: 3035 # "47bd3e25-f4ea-435f-b69b-13cb4f9dd60a", configKey: 'dark mode') { 3036 # 3037 # records: { 3038 # 3039 # configType 3040 # 3041 # defaultValue 3042 # 3043 # } 3044 # 3045 # offset: 0 3046 # 3047 # limit: 1 3048 # 3049 # } 3050 # } 3051 # Response: 3052 # { 3053 # 3054 # "data": { 3055 # 3056 # "applicationConfigDefinition": { 3057 # 3058 # "records": [{ 3059 # 3060 # "configType": Boolean, 3061 # 3062 # "defaultValue": true, 3063 # 3064 # }] 3065 # 3066 # } 3067 # 3068 # } 3069 # } 3070 # 3071 # Arguments 3072 # configKey: If specified, grab definition for this config key 3073 # offset: Specify maximum number of results to retrieve in this 3074 # result. Page size. 3075 # limit: Specify maximum number of results to retrieve in this 3076 # result. 3077 ( 3078 ID!, : 3079 String, : 3080 Int, : 3081 Int : 3082 ): ApplicationConfigDefinitionList! 3083 3084 # Retrieve a single application 3085 # Example: 3086 # Request: 3087 # query { 3088 # 3089 # application(id: "47bd3e25-f4ea-435f-b69b-13cb4f9dd60a") { 3090 # 3091 # name 3092 # 3093 # key 3094 # 3095 # } 3096 # } 3097 # Response: 3098 # { 3099 # 3100 # "data": { 3101 # 3102 # "application": { 3103 # 3104 # "name": "appexamplebill", 3105 # 3106 # "key": "appexamplebill" 3107 # 3108 # } 3109 # 3110 # } 3111 # } 3112 # 3113 # Arguments 3114 # id: The application ID 3115 # excludeViewOnly: Only retrieve package grantType=VIEW when 3116 # explicitly enter false 3117 ID!, : Boolean): Application ( : 3118 3119 # Retrieve headerbar information for an application 3120 # Example: 3121 # Request: 3122 # query { 3123 # 3124 # applicationHeaderbar(id: "47bd3e25-f4ea-435f-b69b-13cb4f9dd60a") { 3125 # 3126 # name 3127 # 3128 # config { 3129 # 3130 # title 3131 # 3132 # } 3133 # 3134 # } 3135 # } 3136 # Response: 3137 # { 3138 # 3139 # "data": { 3140 # 3141 # "applicationHeaderbar": { 3142 # 3143 # "name": "APP_BAR", 3144 # 3145 # "config": { 3146 # 3147 # "title": "Library" 3148 # 3149 # } 3150 # 3151 # } 3152 # 3153 # } 3154 # } 3155 # 3156 # Arguments 3157 # appId: The application ID 3158 # orgId: Optional organization ID. Normally this value is 3159 # computed by the server 3160 # based on the authorization token used for the request. 3161 ID!, : ID): ApplicationHeaderbar ( : 3162 3163 # Retrieve a list of schemas for structured data ingestions\ 3164 # Example: 3165 # Request: 3166 # query { 3167 # 3168 # schemas(limit: 2) { 3169 # 3170 # records { 3171 # 3172 # id 3173 # 3174 # organizationId 3175 # 3176 # } 3177 # 3178 # } 3179 # } 3180 # Response: 3181 # { 3182 # 3183 # "data": { 3184 # 3185 # "schemas": { 3186 # 3187 # "records": [ 3188 # 3189 # { 3190 # 3191 # "id": "21a08123-45dc-497e-b329-360d9f3fcaac", 3192 # 3193 # "organizationId": "35521" 3194 # 3195 # }, 3196 # 3197 # { 3198 # 3199 # "id": "57aa1618-344d-4d35-9980-5fe1ec6c3112", 3200 # 3201 # "organizationId": "35521" 3202 # 3203 # } 3204 # 3205 # ] 3206 # 3207 # } 3208 # 3209 # } 3210 # } 3211 # 3212 # Arguments 3213 # id: Id of a schema to retrieve 3214 # ids: Ids of schemas to retrieve 3215 # dataRegistryId: Specify the id of the DataRegistry to get 3216 # schemas 3217 # status: Specify one or more statuses to filter by schema status 3218 # majorVersion: Specify a major version to filter schemas 3219 # name: Specify a data registry name to filter schemas 3220 # nameMatch: The strategy used to find data registry name 3221 # accessScope: Specify one or more access scopes to filter by 3222 # accessible schemas 3223 # limit: Limit 3224 # offset: Offset 3225 # orderBy: Specify one or more fields and direction to order 3226 # results 3227 ( 3228 ID, : 3229 ID!], : [ 3230 ID, : 3231 SchemaStatus!], : [ 3232 Int, : 3233 String, : 3234 StringMatch, : 3235 AccessScope!], : [ 3236 Int, : 3237 Int, : 3238 SchemaOrder] : [ 3239 ): SchemaList 3240 3241 # Retrieve a schema for structured data ingestions 3242 # Example: 3243 # Request: 3244 # query { 3245 # 3246 # schema(id: "21a08123-45dc-497e-b329-360d9f3fcaac") { 3247 # 3248 # definition 3249 # 3250 # status 3251 # 3252 # } 3253 # } 3254 # Response: 3255 # { 3256 # 3257 # "data": { 3258 # 3259 # "schema": { 3260 # 3261 # "definition": { 3262 # 3263 # "example": "example value" 3264 # 3265 # }, 3266 # 3267 # "status": "draft" 3268 # 3269 # } 3270 # 3271 # } 3272 # } 3273 # 3274 # Arguments 3275 # id: Supply the ID of the schema to retrieve 3276 ID!): Schema ( : 3277 3278 # Example: 3279 # Request: 3280 # query { 3281 # 3282 # schemaProperties(limit: 2) { 3283 # 3284 # records { 3285 # 3286 # type 3287 # 3288 # dataRegistryId 3289 # 3290 # } 3291 # 3292 # } 3293 # } 3294 # Response: 3295 # { 3296 # 3297 # "data": { 3298 # 3299 # "schemaProperties": { 3300 # 3301 # "records": [ 3302 # 3303 # { 3304 # 3305 # "type": "string", 3306 # 3307 # "dataRegistryId": "c3c9fa66-15b2-4bc4-b37f-c790e3ea0db6" 3308 # 3309 # }, 3310 # 3311 # { 3312 # 3313 # "type": "string", 3314 # 3315 # "dataRegistryId": "dbfa78af-f935-4ace-8a70-f70ca36ce49c" 3316 # 3317 # } 3318 # 3319 # ] 3320 # 3321 # } 3322 # 3323 # } 3324 # } 3325 # 3326 # Arguments 3327 # limit: Limit 3328 # offset: Offset 3329 ( 3330 DataRegistryVersion!], : [ 3331 String, : 3332 Int, : 3333 Int : 3334 ): SchemaPropertyList 3335 3336 # Retrieve a structured data object 3337 # Example: 3338 # Request: 3339 # query { 3340 # 3341 # structuredData( 3342 # 3343 # id: "bbc0d388-b7ed-4073-9760-cb7701130eaf", 3344 # 3345 # schemaId: "acab8bd9-a4d4-44de-ad4b-cc949d696cf9") { 3346 # 3347 # data 3348 # 3349 # } 3350 # } 3351 # Response: 3352 # { 3353 # 3354 # "data": { 3355 # 3356 # "structuredData": { 3357 # 3358 # "data": { 3359 # 3360 # "example": "example" 3361 # 3362 # } 3363 # 3364 # } 3365 # 3366 # } 3367 # } 3368 # 3369 # Arguments 3370 # id: Supply the ID of the structured data object to retrieve. 3371 # This will override filters. 3372 # schemaId: Schema Id for the structured data object to retrieve 3373 ID!, : ID!): StructuredData ( : 3374 3375 # Retrieve a structured data object 3376 # Example: 3377 # Request: 3378 # query { 3379 # 3380 # structuredDataObject( 3381 # 3382 # id: "bbc0d388-b7ed-4073-9760-cb7701130eaf", 3383 # 3384 # schemaId: "acab8bd9-a4d4-44de-ad4b-cc949d696cf9") { 3385 # 3386 # data 3387 # 3388 # } 3389 # } 3390 # Response: 3391 # { 3392 # 3393 # "data": { 3394 # 3395 # "structuredDataObject": { 3396 # 3397 # "data": { 3398 # 3399 # "example": "example" 3400 # 3401 # } 3402 # 3403 # } 3404 # 3405 # } 3406 # } 3407 # 3408 # Arguments 3409 # id: Supply the ID of the structured data object to retrieve. 3410 # This will override filters. 3411 # schemaId: Schema Id for the structured data object to retrieve 3412 ID!, : ID!): StructuredData ( : 3413 3414 # Retrieve a paginated list of structured data object 3415 # Example: 3416 # Request: 3417 # query { 3418 # 3419 # structuredDataObjects(schemaId: "acab8bd9-a4d4-44de-ad4b-cc949d696cf9") { 3420 # 3421 # records { 3422 # 3423 # id 3424 # 3425 # data 3426 # 3427 # } 3428 # 3429 # } 3430 # } 3431 # Response: 3432 # { 3433 # 3434 # "data": { 3435 # 3436 # "structuredDataObjects": { 3437 # 3438 # "records": [ 3439 # 3440 # { 3441 # 3442 # "id": "bbc0d388-b7ed-4073-9760-cb7701130eaf", 3443 # 3444 # "data": { 3445 # 3446 # "example": "example" 3447 # 3448 # } 3449 # 3450 # }, 3451 # 3452 # { 3453 # 3454 # "id": "f914eafe-ed9b-46b1-a48d-effd5575764a", 3455 # 3456 # "data": { 3457 # 3458 # "example": "example" 3459 # 3460 # } 3461 # 3462 # } 3463 # 3464 # ] 3465 # 3466 # } 3467 # 3468 # } 3469 # } 3470 # 3471 # Arguments 3472 # id: Supply the ID of the structured data object to retrieve. 3473 # This will override filters. 3474 # ids: List of Ids of the structured data objects to retrieve. 3475 # This will override filters. 3476 # schemaId: Schema Id for the structured data object to retrieve 3477 # filter: Query to filter SDO. Supports operations such as and, 3478 # or, eq, gt, lt, etc. 3479 # TODO link to syntax documentation 3480 ( 3481 ID, : 3482 ID!], : [ 3483 ID!, : 3484 StructuredDataOrderBy!], : [ 3485 Int, : 3486 Int, : 3487 Boolean, : 3488 JSONData : 3489 ): StructuredDataList 3490 3491 # Returns information about the GraphQL server, useful 3492 # for diagnostics. This data is primarily used by Veritone 3493 # development, and some fields may be restricted to Veritone administrators. 3494 GraphQLServiceInfo : 3495 3496 # Returns a signed writable S3 URL. A client can then 3497 # upload to this URL with an HTTP PUT without providing 3498 # any additional authorization (_note_: it must be a PUT. 3499 # A POST will fail.) 3500 # Example: 3501 # Request: 3502 # query { 3503 # 3504 # getSignedWritableUrl(type: "preview") { 3505 # 3506 # bucket 3507 # 3508 # key 3509 # 3510 # url 3511 # 3512 # } 3513 # } 3514 # Response: 3515 # { 3516 # 3517 # "data": { 3518 # 3519 # "getSignedWritableUrl": { 3520 # 3521 # "bucket": "prod-api.veritone.com", 3522 # 3523 # "key": 3524 # "35521/preview/2021/5/5/_/19-50-374_ed2c10a7-6f96-4d7c-a498-7bedeb383c7e", 3525 # 3526 # "url": 3527 # "https://s3.amazonaws.com/prod-api.veritone.com/35521/preview/2021/5/5/_/19-50-374_ed2c10a7-6f96-4d7c-a498-7bedeb383c7e?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQMR5VATUHU3MEGOA%2F20210618%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20210618T194850Z&X-Amz-Expires=86400&X-Amz-Signature=44857350a7f0b7311d4b911b557f4171a6ffe126c76e3d26f6e5cd532f645e53&X-Amz-SignedHeaders=host" 3528 # 3529 # } 3530 # 3531 # } 3532 # } 3533 # 3534 # Arguments 3535 # key: Optional key of the object to generate a writable 3536 # URL for. If not provided, a new, unique key will 3537 # be generated. If a key is provided and resembles a file name 3538 # (with extension delimited by .), a UUID will be inserted 3539 # into the file name, leaving the extension intact. 3540 # If a key is provided and does not resemble 3541 # a file name, a UUID will be appended. 3542 # type: Optional type of resource, such as `asset`, `thumbnail`, 3543 # `discovery-analytics` or `preview` 3544 # path: Optional extended path information. If the uploaded 3545 # content will be contained 3546 # within a container such as a `TemporalDataObject` (for `asset`) or `Library` 3547 # (for `entityIdentifier`), the ID of the object should be provided here. 3548 # expiresInSeconds: Optional expiresInSeconds custom expiration 3549 # to signedUrlExpires 3550 # Max expiresInSeconds up to 604800 3551 # organizationId: Optional organization ID. Normally this value 3552 # is computed by the server 3553 # based on the authorization token used for the request. 3554 # Is is used only by Veritone platform components. 3555 ( 3556 String, : 3557 String, : 3558 String, : 3559 Int, : 3560 ID : 3561 ): WritableUrlInfo 3562 3563 # Return writable storage URLs in bulk. 3564 # A maximum of 1000 can be created in one call. 3565 # See `getSignedWritableUrl` for details on usage of the 3566 # response contents. 3567 # Example: 3568 # Request: 3569 # query { 3570 # 3571 # getSignedWritableUrls(number: 2) { 3572 # 3573 # bucket 3574 # 3575 # key 3576 # 3577 # url 3578 # 3579 # } 3580 # } 3581 # Response: 3582 # { 3583 # 3584 # "data": { 3585 # 3586 # "getSignedWritableUrls": [ 3587 # 3588 # { 3589 # 3590 # "bucket": "prod-api.veritone.com", 3591 # 3592 # "key": "35521/other/2021/5/5/_/19-19-384_723ca284-cee6-4883-af16-edcbfed86433", 3593 # 3594 # "url": 3595 # "https://s3.amazonaws.com/prod-api.veritone.com/35521/other/2021/5/5/_/19-19-384_723ca284-cee6-4883-af16-edcbfed86433?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQMR5VATUHU3MEGOA%2F20210618%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20210618T194919Z&X-Amz-Expires=86400&X-Amz-Signature=57c8d9046297e6d6839d19e7d22552618e9ff89dd4855ca7f7aceb26e89d3de4&X-Amz-SignedHeaders=host" 3596 # 3597 # }, 3598 # 3599 # { 3600 # 3601 # "bucket": "prod-api.veritone.com", 3602 # 3603 # "key": "35521/other/2021/5/6/_/19-19-384_76af4aeb-5d9b-4bc4-b1d0-251e3f57b651", 3604 # 3605 # "url": 3606 # "https://s3.amazonaws.com/prod-api.veritone.com/35521/other/2021/5/6/_/19-19-384_76af4aeb-5d9b-4bc4-b1d0-251e3f57b651?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQMR5VATUHU3MEGOA%2F20210618%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20210618T194919Z&X-Amz-Expires=86400&X-Amz-Signature=9e139df517ca85fa0b969f0d3ff55b890b8a5e199c4fa7b3a26ea2f12a65bfec&X-Amz-SignedHeaders=host" 3607 # 3608 # } 3609 # 3610 # ] 3611 # 3612 # } 3613 # } 3614 # 3615 # Arguments 3616 # number: Number of signed URLs to return 3617 # type: Optional type of resource, such as `asset`, `thumbnail`, 3618 # or `preview` 3619 # path: Optional extended path information. If the uploaded 3620 # content will be contained 3621 # within a container such as a `TemporalDataObject` (for `asset`) or `Library` 3622 # (for `entityIdentifier`), the ID of the object should be provided here. 3623 # organizationId: Optional organization ID. Normally this value 3624 # is computed by the server 3625 # based on the authorization token used for the request. 3626 # Is is used only by Veritone platform components. 3627 ( 3628 Int!, : 3629 String, : 3630 String, : 3631 ID : 3632 ): [WritableUrlInfo!]! 3633 3634 # Retrieve the rights of the current user 3635 # Example: 3636 # Request: 3637 # query { 3638 # 3639 # myRights { 3640 # 3641 # resources 3642 # 3643 # operations 3644 # 3645 # } 3646 # } 3647 # Response: 3648 # { 3649 # 3650 # "data": { 3651 # 3652 # "myRights": { 3653 # 3654 # "resources": {}, 3655 # 3656 # "operations": [ 3657 # 3658 # "admin.access", 3659 # 3660 # "admin.org.read", 3661 # 3662 # "admin.org.update", 3663 # 3664 # "admin.user.create", 3665 # 3666 # "admin.user.read", 3667 # 3668 # "admin.user.update", 3669 # 3670 # "admin.user.delete", 3671 # 3672 # ... 3673 # 3674 # ] 3675 # 3676 # } 3677 # 3678 # } 3679 # } 3680 RightsListing : 3681 3682 # Retrieve the shared folders for an organization 3683 # Example: 3684 # Request: 3685 # query { 3686 # 3687 # sharedFolders { 3688 # 3689 # id 3690 # 3691 # } 3692 # } 3693 # Response: 3694 # { 3695 # 3696 # "data": { 3697 # 3698 # "sharedFolders": [] 3699 # 3700 # } 3701 # } 3702 Folder] : [ 3703 3704 # Retrieve multiple watchlists 3705 # Example: 3706 # Request: 3707 # query { 3708 # 3709 # watchlists(limit: 2) { 3710 # 3711 # records { 3712 # 3713 # id 3714 # 3715 # name 3716 # 3717 # } 3718 # 3719 # } 3720 # } 3721 # Response: 3722 # { 3723 # 3724 # "data": { 3725 # 3726 # "watchlists": { 3727 # 3728 # "records": [ 3729 # 3730 # { 3731 # 3732 # "id": "326916", 3733 # 3734 # "name": "example" 3735 # 3736 # }, 3737 # 3738 # { 3739 # 3740 # "id": "325791", 3741 # 3742 # "name": "example" 3743 # 3744 # } 3745 # 3746 # ] 3747 # 3748 # } 3749 # 3750 # } 3751 # } 3752 # 3753 # Arguments 3754 # isDisabled: Set `true` to include only disabled watchlist or 3755 # `false` to include only enabled watchlists. By default, 3756 # both are included. 3757 # names: Provide a list of names to filter folders 3758 ( 3759 ID, : 3760 DateTime, : 3761 DateTime, : 3762 DateTime, : 3763 DateTime, : 3764 String, : 3765 Int, : 3766 Int, : 3767 WatchlistOrderBy, : 3768 OrderDirection, : 3769 Boolean, : 3770 String], : [ 3771 StringMatch : 3772 ): WatchlistList 3773 3774 # Retrieve a single watchlist by id 3775 # Example: 3776 # Request: 3777 # query { 3778 # 3779 # watchlist(id: "325791") { 3780 # 3781 # name 3782 # 3783 # watchlistType 3784 # 3785 # } 3786 # } 3787 # Response: 3788 # { 3789 # 3790 # "data": { 3791 # 3792 # "watchlist": { 3793 # 3794 # "name": "example", 3795 # 3796 # "watchlistType": "tracking" 3797 # 3798 # } 3799 # 3800 # } 3801 # } 3802 ID!): Watchlist ( : 3803 3804 # Example: 3805 # Request: 3806 # query { 3807 # 3808 # mentionStatusOptions { 3809 # 3810 # id 3811 # 3812 # name 3813 # 3814 # } 3815 # } 3816 # Response: 3817 # { 3818 # 3819 # "data": { 3820 # 3821 # "mentionStatusOptions": [ 3822 # 3823 # { 3824 # 3825 # "id": "7", 3826 # 3827 # "name": "Auto Verified" 3828 # 3829 # }, 3830 # 3831 # { 3832 # 3833 # "id": "5", 3834 # 3835 # "name": "Invalid" 3836 # 3837 # }, 3838 # 3839 # { 3840 # 3841 # "id": "3", 3842 # 3843 # "name": "Needs Review" 3844 # 3845 # }, 3846 # 3847 # { 3848 # 3849 # "id": "1", 3850 # 3851 # "name": "Pending Verification" 3852 # 3853 # }, 3854 # 3855 # { 3856 # 3857 # "id": "6", 3858 # 3859 # "name": "Processing Verification" 3860 # 3861 # }, 3862 # 3863 # { 3864 # 3865 # "id": "4", 3866 # 3867 # "name": "Request Bonus" 3868 # 3869 # }, 3870 # 3871 # { 3872 # 3873 # "id": "2", 3874 # 3875 # "name": "Verified" 3876 # 3877 # } 3878 # 3879 # ] 3880 # 3881 # } 3882 # } 3883 MentionStatus!]! : [ 3884 3885 # Retrieve multiple data registries 3886 # Example: 3887 # Request: 3888 # query { 3889 # 3890 # dataRegistries(limit: 2) { 3891 # 3892 # records { 3893 # 3894 # id 3895 # 3896 # name 3897 # 3898 # } 3899 # 3900 # } 3901 # } 3902 # Response: 3903 # { 3904 # 3905 # "data": { 3906 # 3907 # "dataRegistries": { 3908 # 3909 # "records": [ 3910 # 3911 # { 3912 # 3913 # "id": "532ef261-d3a4-4c09-8fc7-0653a5131577", 3914 # 3915 # "name": "example" 3916 # 3917 # }, 3918 # 3919 # { 3920 # 3921 # "id": "317c941d-30d0-455e-882b-34a26e513364", 3922 # 3923 # "name": "example" 3924 # 3925 # } 3926 # 3927 # ] 3928 # 3929 # } 3930 # 3931 # } 3932 # } 3933 ( 3934 ID, : 3935 ID!], : [ 3936 String, : 3937 StringMatch, : 3938 Int, : 3939 Int, : 3940 DataRegistryOrderBy, : 3941 OrderDirection, : 3942 SchemaOwnership : 3943 ): DataRegistryList 3944 3945 # Retrieve a single data registry 3946 # Example: 3947 # Request: 3948 # query { 3949 # 3950 # dataRegistry(id: "532ef261-d3a4-4c09-8fc7-0653a5131577") { 3951 # 3952 # name 3953 # 3954 # organizationId 3955 # 3956 # source 3957 # 3958 # } 3959 # } 3960 # Response: 3961 # { 3962 # 3963 # "data": { 3964 # 3965 # "dataRegistry": { 3966 # 3967 # "name": "example", 3968 # 3969 # "organizationId": "35521", 3970 # 3971 # "source": "veritone-35521.datasets" 3972 # 3973 # } 3974 # 3975 # } 3976 # } 3977 ID!): DataRegistry ( : 3978 3979 # Retrieve a subscription by id 3980 # Example: 3981 # Request: 3982 # query { 3983 # 3984 # subscription(id: "275818") { 3985 # 3986 # isActive 3987 # 3988 # jsondata 3989 # 3990 # } 3991 # } 3992 # Response: 3993 # { 3994 # 3995 # "data": { 3996 # 3997 # "subscription": { 3998 # 3999 # "isActive": true, 4000 # 4001 # "jsondata": { 4002 # 4003 # "tracking_unit_id": "325791", 4004 # 4005 # "creator_email": "example email", 4006 # 4007 # "unsubscribe_hash": 4008 # "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0cmFja2luZ1VuaXQiOiJ0cmFja2luZ191bml0X2lkIiwiZW1haWxBZGRyZXNzIjoiZW1haWxfYWRkcmVzcyIsInRyYWNraW5nX3VuaXRfaWQiOiIzMjU3OTEiLCJlbWFpbF9hZGRyZXNzIjoiZXhhbXBsZSBlbWFpbCIsImlhdCI6MTYyNDAyMjY4OCwiaXNzIjoidmVyaXRvbmU6ZGlzY292ZXJ5Iiwic3ViIjoidW5zdWJzY3JpYmUifQ.stYGS_goXaEhwLbKtYRohPirUT-q6vuY5hMHt74BWMUuEWYhwAQBxMItoFjZSXc3lHolQutxsl_BDiMOWNS4snRvcn-jI-5HG_4A3gEjQc6sYbgtyeVGxuDAg4urtj5sSBz0AU0xXZwLp2NI0Q39dqQSi1v1ZFANFE-jGULHreE3h617hLKf6CvegaOyrn_wqNONsB6VKDbXoLxdWoYJu3k7UztbvD1SC_bYHc7ltd1Ua2blUXSH0eBlk7pSv1vWdpw9KwMeuPJdC3R3qOB3-0xtp7KzTs0f5TelSZbk-6keVJz4LQt2mDxs6uivd8wb6GJ6Ikw-uKUYuo3T-vL0p-hFA5DkwiToomqTIqXvF5DGJxx762bKLLEKALAC55LdJ7eCZc6DmrnRbYLYNVfc2jK9YBDKeZxUAjNmYvlRsQTpLIrLoxWWmCbOJznfEjrzp_gI24rUh5qZ_-KUHr0pEYd5DuURy_geCmwSedq-nHV8tlE7op1bX8k9fwWFjIS7JIjYquUJq9T2wqIORO0WN6DGhgqkL7texbx9IYSWRkAY26KQxUF08jm5Vh_jrkmRyXsS9r5kVn_AGXbMA_HqtFo2jvXw5OXDcuaRjYwJpf8YtMvjNuDl8t9gbSmKwbeG1FsErPX0ne5K2TRWIqolohIvdHTTfsZLVvWdwmASnYw" 4009 # 4010 # } 4011 # 4012 # } 4013 # 4014 # } 4015 # } 4016 ID!): Subscription! ( : 4017 4018 ID!): CognitiveSearch! ( : 4019 4020 # Retrieve multiple collections 4021 # Example: 4022 # Request: 4023 # query { 4024 # 4025 # collections { 4026 # 4027 # records { 4028 # 4029 # id 4030 # 4031 # name 4032 # 4033 # } 4034 # 4035 # } 4036 # } 4037 # Response: 4038 # { 4039 # 4040 # "data": { 4041 # 4042 # "collections": { 4043 # 4044 # "records": [ 4045 # 4046 # { 4047 # 4048 # "id": "241121", 4049 # 4050 # "name": "example" 4051 # 4052 # }, 4053 # 4054 # { 4055 # 4056 # "id": "242599", 4057 # 4058 # "name": "example" 4059 # 4060 # }, 4061 # 4062 # { 4063 # 4064 # "id": "243625", 4065 # 4066 # "name": "example" 4067 # 4068 # } 4069 # 4070 # ] 4071 # 4072 # } 4073 # 4074 # } 4075 # } 4076 ID, : String, : ID, : Int, : Int): CollectionList! ( : 4077 4078 # Retrieve a collection by id 4079 # Example: 4080 # Request: 4081 # query { 4082 # 4083 # collection(id: "241121") { 4084 # 4085 # name 4086 # 4087 # isActive 4088 # 4089 # } 4090 # } 4091 # Response: 4092 # { 4093 # 4094 # "data": { 4095 # 4096 # "collection": { 4097 # 4098 # "name": "example", 4099 # 4100 # "isActive": true 4101 # 4102 # } 4103 # 4104 # } 4105 # } 4106 ID!): Collection! ( : 4107 4108 ID!, : ID!): CollectionMention! ( : 4109 4110 # Retrieve a list of collection mentions 4111 # Specify at least one of folderId or mentionId 4112 ( 4113 ID, : 4114 ID, : 4115 CollectionMentionOrderBy, : 4116 Int, : 4117 Int : 4118 ): CollectionMentionList! 4119 4120 # Retrieve multiple mentions 4121 # Example: 4122 # Request: 4123 # query { 4124 # 4125 # mentions { 4126 # 4127 # records { 4128 # 4129 # id 4130 # 4131 # } 4132 # 4133 # } 4134 # } 4135 # Response: 4136 # { 4137 # 4138 # "data": { 4139 # 4140 # "mentions": { 4141 # 4142 # "records": [] 4143 # 4144 # } 4145 # 4146 # } 4147 # } 4148 # 4149 # Arguments 4150 # watchlistId: Get mentions created from the specified watchlist 4151 # sourceId: Get mentions associated with the specified source 4152 # sourceTypeId: Get mentions associated with sources of the 4153 # specified source type 4154 # tdoId: Get mentions associated directly with the specific TDO 4155 # dateTimeFilter: Specify date/time filters against mention 4156 # fields. 4157 # Querying for mentions can be expensive. If the query does not 4158 # include a filter by `id`, `tdoId`, `sourceId`, `watchlistId`, or 4159 # a user-provided `dateTimeFilter`, a default filter of the 4160 # past 7 days is applied. 4161 # orderBy: Set order information on the query. Multiple fields 4162 # are supported. 4163 # folderId: Provide a folder ID to filter by collection 4164 ( 4165 ID, : 4166 ID, : 4167 ID, : 4168 ID, : 4169 ID, : 4170 MentionDateTimeFilter!], : [ 4171 MentionOrderBy!], : [ 4172 Int, : 4173 Int, : 4174 ID : 4175 ): MentionList 4176 4177 # Retrieves engine results by TDO and engine ID or by job ID. 4178 # Example: 4179 # Request: 4180 # query { 4181 # 4182 # engineResults( 4183 # 4184 # tdoId: "1580507556", 4185 # 4186 # engineIds: "4") { 4187 # 4188 # sourceId 4189 # 4190 # records { 4191 # 4192 # tdoId 4193 # 4194 # } 4195 # 4196 # } 4197 # } 4198 # Response: 4199 # { 4200 # 4201 # "data": { 4202 # 4203 # "engineResults": { 4204 # 4205 # "sourceId": null, 4206 # 4207 # "records": [] 4208 # 4209 # } 4210 # 4211 # } 4212 # } 4213 # 4214 # Arguments 4215 # tdoId: Provide the ID of the TDO containing engine results to 4216 # retrieve. 4217 # If this parameter is used, engineIds or engineCategoryIds must also be set. 4218 # Results for _only_ the specified TDO will be returned. 4219 # sourceId: Provide the ID of the Source containing engine 4220 # results to retrieve. 4221 # If this parameter is used, engineIds or engineCategoryIds must also be set. 4222 # This takes priority over tdoId. 4223 # engineIds: Provide one or more engine IDs to retrieve engine 4224 # results by 4225 # ID. This parameter is mandatory if tdoId is used, but optional 4226 # if jobId or engineCategory is used. 4227 # engineCategoryIds: Provide one or more category IDs to get all 4228 # results from that categroy. 4229 # jobId: Provide a job ID to retrieve engine results for the job. 4230 # mentionId: Provide a mention ID to retrieve engine results for 4231 # the mention. 4232 # startOffsetMs: Start offset ms for the results. 4233 # stopOffsetMs: End offset ms for the results. 4234 # startDate: Start date for the results. Takes priority over 4235 # startOffsetMs. 4236 # stopDate: End date for the results. Takes priority over 4237 # stopOffsetMs. 4238 # ignoreUserEdited: Whether or not to exclude user edited engine 4239 # results. Defaults to false. 4240 # fallbackTdoId: A TDO ID can be provided for use if the provided 4241 # `sourceId` and/or 4242 # `mentionId` parameters do not resolve to a logical set of TDOs. 4243 # Depending on parameter settings and available data, 4244 # results from other TDOs can be included in the response. 4245 ( 4246 ID, : 4247 ID, : 4248 ID!], : [ 4249 ID!], : [ 4250 ID, : 4251 ID, : 4252 Int, : 4253 Int, : 4254 DateTime, : 4255 DateTime, : 4256 Boolean, : 4257 ID : 4258 ): EngineResultList 4259 4260 # Retrieve a trigger by id 4261 # Example: 4262 # Request: 4263 # query { 4264 # 4265 # trigger(id: "2998") { 4266 # 4267 # target 4268 # 4269 # createdDateTime 4270 # 4271 # } 4272 # } 4273 # Response: 4274 # { 4275 # 4276 # "data": { 4277 # 4278 # "trigger": { 4279 # 4280 # "target": "Email", 4281 # 4282 # "createdDateTime": "2021-06-18T13:35:08.631Z" 4283 # 4284 # } 4285 # 4286 # } 4287 # } 4288 ID!): Trigger ( : 4289 4290 # Retrieve triggers 4291 # Example: 4292 # Request: 4293 # query { 4294 # 4295 # triggers { 4296 # 4297 # id 4298 # 4299 # } 4300 # } 4301 # Response: 4302 # { 4303 # 4304 # "data": { 4305 # 4306 # "triggers": [ 4307 # 4308 # { 4309 # 4310 # "id": "2998" 4311 # 4312 # } 4313 # 4314 # ] 4315 # 4316 # } 4317 # } 4318 Trigger] : [ 4319 4320 # Fetch all saved searches that the current user has made 4321 # Fetch all saved searches that have been shared with 4322 # the current users organization 4323 # Include any saved searches that the user has created 4324 # Example: 4325 # Request: 4326 # query { 4327 # 4328 # savedSearches { 4329 # 4330 # records { 4331 # 4332 # id 4333 # 4334 # name 4335 # 4336 # } 4337 # 4338 # } 4339 # } 4340 # Response: 4341 # { 4342 # 4343 # "data": { 4344 # 4345 # "savedSearches": { 4346 # 4347 # "records": [ 4348 # 4349 # { 4350 # 4351 # "id": "3aa9fecb-d3cb-4fa5-a11b-20e02ae494b9", 4352 # 4353 # "name": "example" 4354 # 4355 # } 4356 # 4357 # ] 4358 # 4359 # } 4360 # 4361 # } 4362 # } 4363 ( 4364 Int, : 4365 Int, : 4366 Boolean, : 4367 String, : 4368 SavedSearchOrderBy, : 4369 OrderDirection : 4370 ): SavedSearchList! 4371 4372 # Retrieve a list of export requests 4373 # Example: 4374 # Request: 4375 # query { 4376 # 4377 # exportRequests(limit: 2) { 4378 # 4379 # records { 4380 # 4381 # id 4382 # 4383 # organizationId 4384 # 4385 # } 4386 # 4387 # } 4388 # } 4389 # Response: 4390 # { 4391 # 4392 # "data": { 4393 # 4394 # "exportRequests": { 4395 # 4396 # "records": [ 4397 # 4398 # { 4399 # 4400 # "id": "938b2d64-6df1-486b-b6ea-29d33dee49ad", 4401 # 4402 # "organizationId": "35521" 4403 # 4404 # } 4405 # 4406 # ] 4407 # 4408 # } 4409 # 4410 # } 4411 # } 4412 # 4413 # Arguments 4414 # id: Provide an ID to retrieve a single export request 4415 # offset: Provide an offset to skip to a certain element in the 4416 # result, for paging. 4417 # limit: Specify maximum number of results to retrieve in this 4418 # result. Page size. 4419 # status: Provide a list of status options to filter by status 4420 # event: Provide an event to retrieve export request. Should be 4421 # 'exportRequest' or 'mentionExportRequest' 4422 # Default value is 'exportRequest' 4423 ( 4424 ID, : 4425 Int, : 4426 Int, : 4427 ExportRequestStatus!], : [ 4428 ExportRequestEvent : 4429 ): ExportRequestList! 4430 4431 # Retrieve a single export request by id 4432 # Example: 4433 # Request: 4434 # query { 4435 # 4436 # exportRequest(id: "938b2d64-6df1-486b-b6ea-29d33dee49ad") { 4437 # 4438 # id 4439 # 4440 # organizationId 4441 # 4442 # requestorId 4443 # 4444 # status 4445 # 4446 # } 4447 # } 4448 # Response: 4449 # { 4450 # 4451 # "data": { 4452 # 4453 # "exportRequest": { 4454 # 4455 # "id": "938b2d64-6df1-486b-b6ea-29d33dee49ad", 4456 # 4457 # "organizationId": "35521", 4458 # 4459 # "requestorId": "59cb4e74-7c31-4267-b91e-d4600bc08008", 4460 # 4461 # "status": "complete" 4462 # 4463 # } 4464 # 4465 # } 4466 # } 4467 # 4468 # Arguments 4469 # event: Provide an event to retrieve export request. Should be 4470 # 'exportRequest' or 'mentionExportRequest' 4471 # Default value is 'exportRequest' 4472 ID!, : ExportRequestEvent): ExportRequest! ( : 4473 4474 # Retrieve a event by id 4475 # Example: 4476 # Request: 4477 # query { 4478 # 4479 # event(id: "55fc7c51-1521-4043-902f-f0f3a357da6d") { 4480 # 4481 # eventName 4482 # 4483 # eventType 4484 # 4485 # description 4486 # 4487 # } 4488 # } 4489 # Response: 4490 # { 4491 # 4492 # "data": { 4493 # 4494 # "event": { 4495 # 4496 # "eventName": "example", 4497 # 4498 # "eventType": "example", 4499 # 4500 # "description": "new example description" 4501 # 4502 # } 4503 # 4504 # } 4505 # } 4506 ID!): Event ( : 4507 4508 # Retrieve a list of events by application 4509 # Example: 4510 # Request: 4511 # query { 4512 # 4513 # events( 4514 # 4515 # application: "system", 4516 # 4517 # limit: 2) { 4518 # 4519 # records { 4520 # 4521 # id 4522 # 4523 # eventName 4524 # 4525 # } 4526 # 4527 # } 4528 # } 4529 # Response: 4530 # { 4531 # 4532 # "data": { 4533 # 4534 # "events": { 4535 # 4536 # "records": [ 4537 # 4538 # { 4539 # 4540 # "id": "8876aa2f-1068-411d-b746-28c867c151cc", 4541 # 4542 # "eventName": "ActionTokenForbidden" 4543 # 4544 # }, 4545 # 4546 # { 4547 # 4548 # "id": "d5082d0e-3c96-4c71-9f27-c679650f2adf", 4549 # 4550 # "eventName": "ActionUserForbidden" 4551 # 4552 # } 4553 # 4554 # ] 4555 # 4556 # } 4557 # 4558 # } 4559 # } 4560 # 4561 # Arguments 4562 # application: Provide an application to retrieve all its events. 4563 # Use 'system' to list all public system events. 4564 # offset: Provide an offset to skip to a certain element in the 4565 # result, for paging. 4566 # limit: Specify maximum number of results to retrieve in this 4567 # result. Page size. 4568 String!, : Int, : Int): EventList! ( : 4569 4570 # Retrieve a list of subscriptions by organization 4571 # Example: 4572 # Request: 4573 # query { 4574 # 4575 # eventSubscriptions(limit: 2) { 4576 # 4577 # records { 4578 # 4579 # id 4580 # 4581 # eventName 4582 # 4583 # } 4584 # 4585 # } 4586 # } 4587 # Response: 4588 # { 4589 # 4590 # "data": { 4591 # 4592 # "eventSubscriptions": { 4593 # 4594 # "records": [ 4595 # 4596 # { 4597 # 4598 # "id": "4a81cdf7-e85b-4dc4-85ce-7c2d300cd194", 4599 # 4600 # "eventName": "LibraryTrainingComplete" 4601 # 4602 # }, 4603 # 4604 # { 4605 # 4606 # "id": "c7c4a969-4500-4d7b-b77f-81b1e64bf112", 4607 # 4608 # "eventName": "LibraryTrainingComplete" 4609 # 4610 # } 4611 # 4612 # ] 4613 # 4614 # } 4615 # 4616 # } 4617 # } 4618 # 4619 # Arguments 4620 # ids: The event subscription ids 4621 # eventName: The name of the event 4622 # eventType: The type of event, such as `mention`, `job`, 4623 # `engine`. 4624 # offset: Provide an offset to skip to a certain element in the 4625 # result, for paging. 4626 # limit: Specify maximum number of results to retrieve in this 4627 # result. Page size. 4628 # orgId: The organization ID with which these event subscriptions 4629 # are associated. 4630 # appId: The application ID with which these event subscriptions 4631 # are associated. 4632 # scope: Event subscription scope 4633 ( 4634 ID!], : [ 4635 String, : 4636 String, : 4637 Int, : 4638 Int, : 4639 ID, : 4640 ID, : 4641 EventSubscriptionScope : 4642 ): EventSubscriptionList! 4643 4644 # Retrieve a subscription by id 4645 # Example: 4646 # Request: 4647 # query { 4648 # 4649 # eventSubscription(id: "4a81cdf7-e85b-4dc4-85ce-7c2d300cd194") { 4650 # 4651 # id 4652 # 4653 # organizationId 4654 # 4655 # eventName 4656 # 4657 # targetName 4658 # 4659 # } 4660 # } 4661 # Response: 4662 # { 4663 # 4664 # "data": { 4665 # 4666 # "eventSubscription": { 4667 # 4668 # "id": "4a81cdf7-e85b-4dc4-85ce-7c2d300cd194", 4669 # 4670 # "organizationId": "35521", 4671 # 4672 # "eventName": "LibraryTrainingComplete", 4673 # 4674 # "targetName": "NotificationMailbox" 4675 # 4676 # } 4677 # 4678 # } 4679 # } 4680 ID!): EventSubscription! ( : 4681 4682 # Example: 4683 # Request: 4684 # query { 4685 # 4686 # eventActionTemplate(id: "d02522d7-ef5f-448f-981a-d2cfc7603d92") { 4687 # 4688 # organizationId 4689 # 4690 # actionType 4691 # 4692 # name 4693 # 4694 # } 4695 # } 4696 # Response: 4697 # { 4698 # 4699 # "data": { 4700 # 4701 # "eventActionTemplate": { 4702 # 4703 # "organizationId": "35521", 4704 # 4705 # "actionType": "job", 4706 # 4707 # "name": "example" 4708 # 4709 # } 4710 # 4711 # } 4712 # } 4713 ID!): EventActionTemplate ( : 4714 4715 # Example: 4716 # Request: 4717 # query { 4718 # 4719 # eventActionTemplates( 4720 # 4721 # inputType: event, 4722 # 4723 # actionType: job 4724 # 4725 # limit:2) { 4726 # 4727 # records { 4728 # 4729 # id 4730 # 4731 # name 4732 # 4733 # } 4734 # 4735 # } 4736 # } 4737 # Response: 4738 # { 4739 # 4740 # "data": { 4741 # 4742 # "eventActionTemplates": { 4743 # 4744 # "records": [ 4745 # 4746 # { 4747 # 4748 # "id": "d02522d7-ef5f-448f-981a-d2cfc7603d92", 4749 # 4750 # "name": "example" 4751 # 4752 # }, 4753 # 4754 # { 4755 # 4756 # "id": "49d28375-b6b2-418e-b965-8e939d1189ae", 4757 # 4758 # "name": "example" 4759 # 4760 # } 4761 # 4762 # ] 4763 # 4764 # } 4765 # 4766 # } 4767 # } 4768 # 4769 # Arguments 4770 # ownerApplicationId: The application id 4771 # inputType: use "event" for now. In the future, we allow 4772 # additional input_type types. For example, a schedule or a tweet. 4773 # actionType: Either "job", "webhook", "sms", "email". Future 4774 # action_type could be "gql" where action is purely a function call. 4775 # offset: Provide an offset to skip to a certain element in the 4776 # result, for paging. 4777 # limit: Specify maximum number of results to retrieve in this 4778 # result. Page size. 4779 ( 4780 ID, : 4781 EventActionTemplateInputType, : 4782 EventActionTemplateActionType, : 4783 Int, : 4784 Int : 4785 ): EventActionTemplateList! 4786 4787 # Example: 4788 # Request: 4789 # query { 4790 # 4791 # eventCustomRule(id: "c2c1ee13-37d2-4f92-9156-5cb1a3c59ed5") { 4792 # 4793 # name 4794 # 4795 # eventName 4796 # 4797 # description 4798 # 4799 # } 4800 # } 4801 # Response: 4802 # { 4803 # 4804 # "data": { 4805 # 4806 # "eventCustomRule": { 4807 # 4808 # "name": "example", 4809 # 4810 # "eventName": "example", 4811 # 4812 # "description": "example description" 4813 # 4814 # } 4815 # 4816 # } 4817 # } 4818 ID!): EventCustomRule ( : 4819 4820 # Example: 4821 # Request: 4822 # query { 4823 # 4824 # eventCustomRules(limit: 2) { 4825 # 4826 # records { 4827 # 4828 # id 4829 # 4830 # name 4831 # 4832 # } 4833 # 4834 # } 4835 # } 4836 # Response: 4837 # { 4838 # 4839 # "data": { 4840 # 4841 # "eventCustomRules": { 4842 # 4843 # "records": [ 4844 # 4845 # { 4846 # 4847 # "id": "c2c1ee13-37d2-4f92-9156-5cb1a3c59ed5", 4848 # 4849 # "name": "example" 4850 # 4851 # } 4852 # 4853 # ] 4854 # 4855 # } 4856 # 4857 # } 4858 # } 4859 # 4860 # Arguments 4861 # offset: the offset to skip to a certain element in the result 4862 # limit: the maximum number of rows in the results 4863 Int, : Int): EventCustomRuleList! ( : 4864 4865 # This query returns information about time zones recognized by this 4866 # 4867 # server. The information is static and does not change. 4868 # 4869 # Example: 4870 # 4871 # Request: 4872 # 4873 # query { 4874 # 4875 # timeZones { 4876 # 4877 # name 4878 # 4879 # abbreviations{ 4880 # 4881 # name 4882 # 4883 # } 4884 # 4885 # } 4886 # } 4887 # Response: 4888 # { 4889 # 4890 # "data": { 4891 # 4892 # "timeZones": [ 4893 # 4894 # { 4895 # 4896 # "name": "Africa/Abidjan", 4897 # 4898 # "abbreviations": [ 4899 # 4900 # { 4901 # 4902 # "name": "GMT" 4903 # 4904 # } 4905 # 4906 # ] 4907 # 4908 # }, 4909 # 4910 # { 4911 # 4912 # "name": "Africa/Accra", 4913 # 4914 # "abbreviations": [ 4915 # 4916 # { 4917 # 4918 # "name": "GMT" 4919 # 4920 # }, 4921 # 4922 # { 4923 # 4924 # "name": "+0020" 4925 # 4926 # } 4927 # 4928 # ] 4929 # 4930 # }, 4931 # 4932 # { 4933 # 4934 # "name": "Africa/Lagos", 4935 # 4936 # "abbreviations": [ 4937 # 4938 # { 4939 # 4940 # "name": "WAT" 4941 # 4942 # } 4943 # 4944 # ] 4945 # 4946 # }, 4947 # 4948 # ... 4949 # 4950 # ... 4951 # 4952 # ] 4953 # 4954 # } 4955 # 4956 # ] 4957 # 4958 # } 4959 # } 4960 TimeZone!]! : [ 4961 4962 # Examine entries from the audit log. All operations that modify data are 4963 # written to the audit log. Only entries for the user's own organization 4964 # can be queried. 4965 # All queries are bracketed by a time window. A default time window is applied 4966 # if the `toDateTime` and/or `fromDateTime` parameters are not provided. 4967 # The maximum time window length is 30 days. 4968 # Only Veritone and organization administrators can use this query. 4969 # Example: 4970 # Request: 4971 # query { 4972 # 4973 # auditLog(limit: 2) { 4974 # 4975 # records { 4976 # 4977 # id 4978 # 4979 # objectId 4980 # 4981 # description 4982 # 4983 # } 4984 # 4985 # } 4986 # } 4987 # Response: 4988 # { 4989 # 4990 # "data": { 4991 # 4992 # "auditLog": { 4993 # 4994 # "records": [ 4995 # 4996 # { 4997 # 4998 # "id": "735915311", 4999 # 5000 # "objectId": "*********", 5001 # 5002 # "description": "Changed password" 5003 # 5004 # }, 5005 # 5006 # { 5007 # 5008 # "id": "735915307", 5009 # 5010 # "objectId": "********", 5011 # 5012 # "description": "Changed password" 5013 # 5014 # } 5015 # 5016 # ] 5017 # 5018 # } 5019 # 5020 # } 5021 # } 5022 # 5023 # Arguments 5024 # toDateTime: Date/time up to which entries will be returned. In 5025 # other words, the 5026 # end of the query time window. 5027 # Defaults to the current time. 5028 # fromDateTime: Date/time from which entries will be returned. In 5029 # other words, the 5030 # start of the query time window. 5031 # Defaults to the `toDateTime` minus 7 days. 5032 # organizationId: Organization ID to query records for. This 5033 # value can only be used by 5034 # Veritone administrators. Any value provided by user administrators will 5035 # be ignored. 5036 # userName: User name on audit entry. Must be exact match. 5037 # clientIpAddress: IP address of the client that generated the 5038 # audit action. Must be exact match. 5039 # clientUserAgent: HTTP user agent of the client that generated 5040 # the audit action. Must be exact match. 5041 # eventType: The event type, such as `Create`, `Update`, or 5042 # `Delete`. 5043 # Must be exact match. 5044 # objectId: The ID of the object involved in the audit action. 5045 # The format of this ID 5046 # varies by object type. Must be exact match. 5047 # objectType: The type of the object involved in the audit 5048 # action, such as `Watchlist` 5049 # or `TemporalDataObject`. Must be exact match. 5050 # success: Whether or not the action was successful. 5051 # id: The unique ID of an audit log entry. Multiple values can be 5052 # provided. 5053 # offset: Offset into result set, for paging. 5054 # limit: Limit on result size, for paging (page size). Audit 5055 # queries are 5056 # lightweight so the default of 100 is higher than the default offset 5057 # used elsewhere in the API. 5058 # orderBy: Order information. Default is order by 5059 # `createdDateTime` descending. 5060 ( 5061 DateTime, : 5062 DateTime, : 5063 ID, : 5064 String, : 5065 String, : 5066 String, : 5067 String, : 5068 ID, : 5069 String, : 5070 Boolean, : 5071 ID!], : [ 5072 Int, : 5073 Int, : 5074 AuditLogOrderBy!] : [ 5075 ): AuditLogEntryList! 5076 5077 # Get the media share by media shareId 5078 ID!): MediaShare! ( : 5079 5080 # Retrieve a shared collection 5081 # 5082 # Arguments 5083 # shareId: share token 5084 ID!): SharedCollection ( : 5085 5086 # Retrieve shared collection history records 5087 # Example: 5088 # Request: 5089 # query { 5090 # 5091 # sharedCollectionHistory(limit: 2, 5092 # 5093 # folderId: "d551fbd6-7354-4b0e-abfb-654ab8583be2") { 5094 # 5095 # records { 5096 # 5097 # id 5098 # 5099 # status 5100 # 5101 # shareId 5102 # 5103 # } 5104 # 5105 # } 5106 # } 5107 # Response: 5108 # { 5109 # 5110 # "data": { 5111 # 5112 # "sharedCollectionHistory": { 5113 # 5114 # "records": [] 5115 # 5116 # } 5117 # 5118 # } 5119 # } 5120 # 5121 # Arguments 5122 # ids: Provide an ID to retrieve a single history record 5123 # folderId: Provide a folder ID to filter by collection 5124 # shareId: Provide a share ID to filter by share ID 5125 # offset: Specify maximum number of results to retrieve in this 5126 # result. Page size. 5127 # limit: Specify maximum number of results to retrieve in this 5128 # result. 5129 ( 5130 ID!], : [ 5131 ID, : 5132 String, : 5133 Int, : 5134 Int : 5135 ): SharedCollectionHistoryList! 5136 5137 # Get list process templates by id or current organizationId 5138 # Example: 5139 # Request: 5140 # query { 5141 # 5142 # processTemplates(limit: 2) { 5143 # 5144 # records { 5145 # 5146 # id 5147 # 5148 # organizationId 5149 # 5150 # name 5151 # 5152 # } 5153 # 5154 # } 5155 # } 5156 # Response: 5157 # { 5158 # 5159 # "data": { 5160 # 5161 # "processTemplates": { 5162 # 5163 # "records": [ 5164 # 5165 # { 5166 # 5167 # "id": "762", 5168 # 5169 # "organizationId": "35521", 5170 # 5171 # "name": "example" 5172 # 5173 # } 5174 # 5175 # ] 5176 # 5177 # } 5178 # 5179 # } 5180 # } 5181 ID, : Int, : Int): ProcessTemplateList! ( : 5182 5183 # Get process templates by id 5184 # Example: 5185 # Request: 5186 # query { 5187 # 5188 # processTemplate(id: "762") { 5189 # 5190 # name 5191 # 5192 # organizationId 5193 # 5194 # } 5195 # } 5196 # Response: 5197 # { 5198 # 5199 # "data": { 5200 # 5201 # "processTemplate": { 5202 # 5203 # "name": "example", 5204 # 5205 # "organizationId": "35521" 5206 # 5207 # } 5208 # 5209 # } 5210 # } 5211 ID!): ProcessTemplate! ( : 5212 5213 # Get creative by id with current organizationId 5214 # Example: 5215 # Request: 5216 # query { 5217 # 5218 # creative(id: "25209") { 5219 # 5220 # organizationId 5221 # 5222 # brandId 5223 # 5224 # } 5225 # } 5226 # Response: 5227 # { 5228 # 5229 # "data": { 5230 # 5231 # "creative": { 5232 # 5233 # "organizationId": "35521", 5234 # 5235 # "brandId": null 5236 # 5237 # } 5238 # 5239 # } 5240 # } 5241 ID!): Creative! ( : 5242 5243 # Retrieve list of engine classes 5244 # Example: 5245 # Request: 5246 # query { 5247 # 5248 # engineClasses(limit: 2) { 5249 # 5250 # records { 5251 # 5252 # id 5253 # 5254 # name 5255 # 5256 # description 5257 # 5258 # } 5259 # 5260 # } 5261 # } 5262 # Response: 5263 # { 5264 # 5265 # "data": { 5266 # 5267 # "engineClasses": { 5268 # 5269 # "records": [ 5270 # 5271 # { 5272 # 5273 # "id": "e0283fdf-7f85-472e-b367-59cc8d205ba7", 5274 # 5275 # "name": "audio", 5276 # 5277 # "description": "The input to engines in the Audio class is an audio or video 5278 # file or stream. If your engine processes human speech or voice, it likely 5279 # belongs in the Speech class instead. Audio engines may recognize a specific 5280 # audio segment, such as an advertisement, identify sounds like that of a crying 5281 # baby or detect the presence of audio or music in an audio or video file, for 5282 # example." 5283 # 5284 # }, 5285 # 5286 # { 5287 # 5288 # "id": "1bcfdd35-1e9b-4694-8273-00b19510d164", 5289 # 5290 # "name": "biometrics", 5291 # 5292 # "description": "The input to engines in the Biometrics class may be an image, 5293 # speech or other audio or video file or stream. By definition, the Biometrics 5294 # class covers cognitive analysis related to data points from the human body. 5295 # Biometrics engines may detect or recognize faces, identify face attributes to 5296 # estimate a person's age or ethnicity or verify a person based on their unique 5297 # iris, for example." 5298 # 5299 # } 5300 # 5301 # ] 5302 # 5303 # } 5304 # 5305 # } 5306 # } 5307 # 5308 # Arguments 5309 # id: Provide an ID to retrieve a single specific engine class. 5310 # name: Provide a name, or part of one, to search by class name 5311 # offset: Specify maximum number of results to retrieve in this 5312 # result. Page size. 5313 # limit: Specify maximum number of results to retrieve in this 5314 # result. 5315 ID, : String, : Int, : Int): EngineClassList ( : 5316 5317 # Retrieve a specific engine class 5318 # Example: 5319 # Request: 5320 # query { 5321 # 5322 # engineClass(id: "e0283fdf-7f85-472e-b367-59cc8d205ba7") { 5323 # 5324 # id 5325 # 5326 # name 5327 # 5328 # description 5329 # 5330 # } 5331 # } 5332 # Response: 5333 # { 5334 # 5335 # "data": { 5336 # 5337 # "engineClass": { 5338 # 5339 # "id": "e0283fdf-7f85-472e-b367-59cc8d205ba7", 5340 # 5341 # "name": "audio", 5342 # 5343 # "description": "The input to engines in the Audio class is an audio or video 5344 # file or stream. If your engine processes human speech or voice, it likely 5345 # belongs in the Speech class instead. Audio engines may recognize a specific 5346 # audio segment, such as an advertisement, identify sounds like that of a crying 5347 # baby or detect the presence of audio or music in an audio or video file, for 5348 # example." 5349 # 5350 # } 5351 # 5352 # } 5353 # } 5354 # 5355 # Arguments 5356 # id: Supply the ID of the engine class to retrieve 5357 ID!): EngineClass ( : 5358 5359 # Retrieve list entity tags where tag key contains user input 5360 # Example: 5361 # Request: 5362 # query { 5363 # 5364 # matchEntityTags(input: { tagKey: "test}) { 5365 # 5366 # records { 5367 # 5368 # tagKey 5369 # 5370 # tagValue 5371 # 5372 # } 5373 # 5374 # } 5375 # } 5376 # Response: 5377 # { 5378 # 5379 # "data": { 5380 # 5381 # "matchEntityTags": { 5382 # 5383 # "records": [ 5384 # 5385 # { 5386 # 5387 # "tagKey": "test-tag", 5388 # 5389 # "tagValue": "test-value" 5390 # 5391 # }, 5392 # 5393 # { 5394 # 5395 # "tagKey": "another-testtag", 5396 # 5397 # "tagValue": "" 5398 # 5399 # }, 5400 # 5401 # ] 5402 # 5403 # } 5404 # 5405 # } 5406 # } 5407 # 5408 # Arguments 5409 # input: User provided text and entity type input. 5410 # offset: Specify maximum number of results to retrieve in this 5411 # result. Page size. 5412 # limit: Specify maximum number of results to retrieve in this 5413 # result. 5414 MatchEntityTagInput!, : Int, : Int): MatchedEntityTagsList ( : 5415 5416 # Returns all custom dashboards created by user 5417 # Example: 5418 # Request: 5419 # query { 5420 # 5421 # customDashboards { 5422 # 5423 # records { 5424 # 5425 # id 5426 # 5427 # description 5428 # 5429 # hostAppId 5430 # 5431 # } 5432 # 5433 # } 5434 # } 5435 # Response: 5436 # { 5437 # 5438 # "data": { 5439 # 5440 # "customDashboards": { 5441 # 5442 # "records": [ 5443 # 5444 # { 5445 # 5446 # "id": "a20ae938-e827-4b0b-a62a-6c9af0b98cc9", 5447 # 5448 # "description": "example", 5449 # 5450 # "hostAppId": "80354999-d633-4595-9578-d82f59a5134f" 5451 # 5452 # } 5453 # 5454 # ] 5455 # 5456 # } 5457 # 5458 # } 5459 # } 5460 # 5461 # Arguments 5462 # offset: Provide an offset to skip to a certain element in the 5463 # result, for paging. 5464 # limit: Specify maximum number of results to retrieve in this 5465 # result. Page size. 5466 # hostAppId: Include only dashboards created by specific 5467 # host_app_id 5468 Int, : Int, : ID): CustomDashboardList ( : 5469 5470 # Returns custom dashboard by id 5471 # Example: 5472 # Request: 5473 # query { 5474 # 5475 # customDashboard(id: "a20ae938-e827-4b0b-a62a-6c9af0b98cc9") { 5476 # 5477 # hostAppId 5478 # 5479 # name 5480 # 5481 # } 5482 # } 5483 # Response: 5484 # { 5485 # 5486 # "data": { 5487 # 5488 # "customDashboard": { 5489 # 5490 # "hostAppId": "80354999-d633-4595-9578-d82f59a5134f", 5491 # 5492 # "name": "example" 5493 # 5494 # } 5495 # 5496 # } 5497 # } 5498 ID!): CustomDashboard ( : 5499 5500 # Gets engine usage for an organization based on their billing type. 5501 # Example: 5502 # Request: 5503 # query { 5504 # 5505 # getUsageByTaskType { 5506 # 5507 # totalDuration 5508 # 5509 # totalCost 5510 # 5511 # } 5512 # } 5513 # Response: 5514 # { 5515 # 5516 # "data": { 5517 # 5518 # "getUsageByTaskType": { 5519 # 5520 # "totalDuration": 0, 5521 # 5522 # "totalCost": "0" 5523 # 5524 # } 5525 # 5526 # } 5527 # } 5528 UsageByTaskType! : 5529 5530 # Retrives the specific Dataset 5531 # 5532 # Arguments 5533 # id: Supply the ID of the Dataset to retrieve 5534 ID!): Dataset ( : 5535 5536 # Retrieve list of Datasets 5537 # Example: 5538 # Request: 5539 # query { 5540 # 5541 # datasets(limit:2, filter: {operation:OR}) { 5542 # 5543 # records { 5544 # 5545 # datasetId 5546 # 5547 # name 5548 # 5549 # } 5550 # 5551 # } 5552 # } 5553 # Response: 5554 # { 5555 # 5556 # "data": { 5557 # 5558 # "datasets": { 5559 # 5560 # "records": [] 5561 # 5562 # } 5563 # 5564 # } 5565 # } 5566 # 5567 # Arguments 5568 # offset: Provide an offset to skip to a certain element in the 5569 # result, for paging. 5570 # limit: Specify maximum number of results to retrieve in this 5571 # result. Page size. 5572 # filter: Filters for Dataset attributes 5573 Int, : Int, : DatasetFilter): DatasetList ( : 5574 5575 # Arguments 5576 # datasetId: Supply the ID of the Dataset to retrieve 5577 # offset: Provide an offset to skip to a certain element in the 5578 # result, for paging. 5579 # limit: Specify maximum number of results to retrieve in this 5580 # result. Page size. 5581 # filter: Query to filter SDO. Supports operations such as and, 5582 # or, eq, gt, lt, etc. 5583 # TODO link to syntax documentation 5584 # orderBy: Order by 5585 ( 5586 ID!, : 5587 Int, : 5588 Int, : 5589 JSONData, : 5590 StructuredDataOrderBy!] : [ 5591 ): DatasetEntryList! 5592 5593 # Retrive list of Engine Replacement 5594 # Example: 5595 # Request: 5596 # query { 5597 # 5598 # taskReplacementEngines { 5599 # 5600 # records { 5601 # 5602 # sourceEngineId 5603 # 5604 # replacementEngineId 5605 # 5606 # } 5607 # 5608 # } 5609 # } 5610 # Response: 5611 # { 5612 # 5613 # "data": { 5614 # 5615 # "taskReplacementEngines": { 5616 # 5617 # "records": [ 5618 # 5619 # { 5620 # 5621 # "sourceEngineId": "1", 5622 # 5623 # "replacementEngineId": "2" 5624 # 5625 # } 5626 # 5627 # ] 5628 # 5629 # } 5630 # 5631 # } 5632 # } 5633 # 5634 # Arguments 5635 # organizationId: Only superadmin can get engine replacement of 5636 # other orgs 5637 # engineId: Filter by the source engineId 5638 # offset: Provide an offset to skip to a certain element in the 5639 # result, for paging. 5640 # limit: Specify maximum number of results to retrieve in this 5641 # result. Page size. 5642 ( 5643 ID, : 5644 ID, : 5645 Int, : 5646 Int : 5647 ): TaskReplacementEngineList 5648 5649 # Retrive Notification Mailboxes by list of mailboxIds 5650 # Example: 5651 # Request: 5652 # query { 5653 # 5654 # notificationMailboxes { 5655 # 5656 # id 5657 # 5658 # name 5659 # 5660 # } 5661 # } 5662 # Response: 5663 # { 5664 # 5665 # "data": { 5666 # 5667 # "notificationMailboxes": [ 5668 # 5669 # { 5670 # 5671 # "id": "6fda80b5-3d1a-4eb8-bd32-277be5104149", 5672 # 5673 # "name": "example" 5674 # 5675 # }, 5676 # 5677 # { 5678 # 5679 # "id": "d20e9f37-a887-41bb-aed0-3268884ecebc", 5680 # 5681 # "name": "Library training mailbox" 5682 # 5683 # }, 5684 # 5685 # { 5686 # 5687 # "id": "2d29533b-560e-4354-b794-84f823d33205", 5688 # 5689 # "name": "Library training mailbox" 5690 # 5691 # } 5692 # 5693 # ] 5694 # 5695 # } 5696 # } 5697 ID!]): [NotificationMailbox!] ( : [ 5698 5699 # Retrive Notification Templates 5700 # Example: 5701 # Request: 5702 # query { 5703 # 5704 # notificationTemplates(limit: 2) { 5705 # 5706 # records { 5707 # 5708 # id 5709 # 5710 # eventName 5711 # 5712 # } 5713 # 5714 # } 5715 # } 5716 # Response: 5717 # { 5718 # 5719 # "data": { 5720 # 5721 # "notificationTemplates": { 5722 # 5723 # "records": [ 5724 # 5725 # { 5726 # 5727 # "id": "3947b833-2be4-4415-8272-2cee62fbca23", 5728 # 5729 # "eventName": "example" 5730 # 5731 # } 5732 # 5733 # ] 5734 # 5735 # } 5736 # 5737 # } 5738 # } 5739 # 5740 # Arguments 5741 # ids: Get by array of ids 5742 # eventName: Get by eventName 5743 # eventType: Get by eventType 5744 # application: Get by application 5745 # mailboxId: Get by mailboxId 5746 # ownerOrganizationId: Only super-admin or orgless token can get 5747 # templates by ownerOrganizationId 5748 # offset: Provide an offset to skip to a certain element in the 5749 # result, for paging. 5750 # limit: Specify maximum number of results to retrieve in this 5751 # result. Page size. 5752 ( 5753 ID], : [ 5754 String, : 5755 String, : 5756 String, : 5757 ID, : 5758 ID, : 5759 Int, : 5760 Int : 5761 ): NotificationTemplateList 5762 5763 # Retrieve Notification Actions 5764 # Example: 5765 # Request: 5766 # query { 5767 # 5768 # notificationActions { 5769 # 5770 # records { 5771 # 5772 # id 5773 # 5774 # actionName 5775 # 5776 # } 5777 # 5778 # } 5779 # } 5780 # Response: 5781 # { 5782 # 5783 # "data": { 5784 # 5785 # "notificationActions": { 5786 # 5787 # "records": [ 5788 # 5789 # { 5790 # 5791 # "id": "866aad9c-9e68-4c33-b523-373bb332aea2", 5792 # 5793 # "actionName": "example" 5794 # 5795 # } 5796 # 5797 # ] 5798 # 5799 # } 5800 # 5801 # } 5802 # } 5803 # 5804 # Arguments 5805 # ids: Get by array of ids 5806 # eventName: Get by eventName 5807 # eventType: Get by eventType 5808 # application: Get by application 5809 # mailboxId: Get by mailboxId 5810 # ownerOrganizationId: Only super-admin or orgless token can get 5811 # templates by ownerOrganizationId 5812 # offset: Provide an offset to skip to a certain element in the 5813 # result, for paging. 5814 # limit: Specify maximum number of results to retrieve in this 5815 # result. Page size. 5816 ( 5817 ID], : [ 5818 String, : 5819 String, : 5820 String, : 5821 ID, : 5822 ID, : 5823 Int, : 5824 Int : 5825 ): NotificationActionList 5826 5827 # Retrieve Application user setting definitions 5828 # Example: 5829 # Request: 5830 # query { 5831 # 5832 # getUserSettingDefinitions(application: "80354999-d633-4595-9578-d82f59a5134f") { 5833 # 5834 # key 5835 # 5836 # value 5837 # 5838 # } 5839 # } 5840 # Response: 5841 # { 5842 # 5843 # "data": { 5844 # 5845 # "getUserSettingDefinitions": [ 5846 # 5847 # { 5848 # 5849 # "key": "example", 5850 # 5851 # "value": "example" 5852 # 5853 # } 5854 # 5855 # ] 5856 # 5857 # } 5858 # } 5859 # 5860 # Arguments 5861 # application: Specify the applicationId 5862 # key: Specify the key of user setting (optional) 5863 # organizationGuid: Specify the organizationGuid (require for 5864 # internal token) 5865 # This can be specified by superadmin to get user setting definitions of other 5866 # organization 5867 ( 5868 ID!, : 5869 String, : 5870 ID : 5871 ): [ApplicationSetting] 5872 5873 # Retrive User setting 5874 # Example: 5875 # Request: 5876 # query { 5877 # 5878 # getUserSettings { 5879 # 5880 # key 5881 # 5882 # applicationId 5883 # 5884 # } 5885 # } 5886 # Response: 5887 # { 5888 # 5889 # "data": { 5890 # 5891 # "getUserSettings": [ 5892 # 5893 # { 5894 # 5895 # "key": "example12", 5896 # 5897 # "applicationId": "80354999-d633-4595-9578-d82f59a5134f" 5898 # 5899 # } 5900 # 5901 # ] 5902 # 5903 # } 5904 # } 5905 # 5906 # Arguments 5907 # userId: Filter by userId (optional). 5908 # If it's not specified, default is current user 5909 # application: Filter by applicationId 5910 # keys: Filter by keys 5911 ID, : ID, : [String]): [UserSetting] ( : 5912 5913 # Example: 5914 # Request: 5915 # query { 5916 # 5917 # staticAppConfig { 5918 # 5919 # loginUrl 5920 # 5921 # apiRoot 5922 # 5923 # } 5924 # } 5925 # Response: 5926 # { 5927 # 5928 # "data": { 5929 # 5930 # "staticAppConfig": { 5931 # 5932 # "loginUrl": "https://login.veritone.com", 5933 # 5934 # "apiRoot": "https://api.veritone.com" 5935 # 5936 # } 5937 # 5938 # } 5939 # } 5940 StaticAppConfig! : 5941 5942 # Get OpenID Provider by id 5943 ID!): OpenIdProvider! ( : 5944 5945 # Get OpenID Provides 5946 # Example: 5947 # Request: 5948 # query { 5949 # 5950 # openIdProviders { 5951 # 5952 # records { 5953 # 5954 # id 5955 # 5956 # isGlobal 5957 # 5958 # websiteUrl 5959 # 5960 # } 5961 # 5962 # } 5963 # } 5964 # Response: 5965 # { 5966 # 5967 # "data": { 5968 # 5969 # "openIdProviders": { 5970 # 5971 # "records": [] 5972 # 5973 # } 5974 # 5975 # } 5976 # } 5977 # 5978 # Arguments 5979 # orgId: Filter Providers by organizationId. This is only used by 5980 # superadmin. 5981 # If filter with org-admin role, orgId is always the current user org. 5982 ( 5983 ID], : [ 5984 Boolean, : 5985 ID, : 5986 Int, : 5987 Int : 5988 ): OpenIdProviderList 5989 5990 # Arguments 5991 # orgId: This returns all packages that the Organization has 5992 # access to. 5993 # 5994 # ___Note: for Super-Admin use only.___ 5995 # resourceId: This returns packages that have the provided 5996 # resource linked to it 5997 # resourceAlias: This returns any packages have resources that 5998 # have the alias. 5999 # primaryResourceId: This returns packages that have the provided 6000 # resource as its primary resource 6001 # sourceOriginId: This returns the entire lineage of packages 6002 # that share the same sourceOriginId. 6003 # 6004 # This UUID is used to track a package's lineage. This UUID and versions is NOT 6005 # guaranteed to be a package ID and should not be used as such. 6006 # sourcePackageId: This returns any packages that immediately 6007 # derive from the provided ID. 6008 # 6009 # The sourcePackageId of a package refers to the package that it derived from, if 6010 # any. 6011 # For example, there is a lineage of packages that contain versions 1.0, 2.0, 3.0, 6012 # and 4.0. 6013 # If the ID of version 2.0 is provided, this filter will return the package 6014 # information for 6015 # only version 3.0. This is because version 3.0 is the immediate descendent of 6016 # version 2.0. 6017 # packageFilter: Fields to filter the results by. 6018 # distributionType: This returns packages of a specific 6019 # distribution type 6020 # status: This returns packages with a specific status 6021 # nameRegexp: name regexp pattern 6022 # owned: If true, return only packages owned by the calling org. 6023 # 6024 # If false, return all packages that the calling org has access to. 6025 # 6026 # The default behavior when `owned` is not provided assumes `false`. 6027 # 6028 # __Note__: Superadmin tokens are authorized to change the `orgId` field. If 6029 # provided, the above behavior will apply to `orgId` instead of the calling org. 6030 # includeDeleted: If true, result includes deleted packages 6031 # offset: Provide an offset to skip to a certain element in the 6032 # result, for paging. 6033 # limit: Specify maximum number of results to retrieve in this 6034 # result. Page size. 6035 ( 6036 ID, : 6037 ID, : 6038 ID, : 6039 String, : 6040 ID, : 6041 ID, : 6042 ID, : 6043 PackageFilter, : 6044 EngineDistributionType, : 6045 PackageStatus, : 6046 String, : 6047 Boolean, : 6048 Boolean, : 6049 Int, : 6050 Int : 6051 ): PackageList 6052 6053 # List existing package grants. 6054 # Either packageId or organizationId must be specified. 6055 # 6056 # The following examples assume that the caller is the owner of the Packages: 6057 # packageGrants(id: 123) - Show Grants for Package 123 6058 # packageGrants(organizationId: 12) - Show Grants for all Packages to Org 12 6059 # packageGrants(id: 123, organizationId: 12) Show Grants for Package 123 to Org 12 6060 # 6061 # Arguments 6062 # id: Package ID. If specified, show all the Grants for this 6063 # Package. 6064 # 6065 # If calling Org is owner of the Package, show all Grants. 6066 # 6067 # If calling Org is not owner of the Package, only show Grants for the Package to 6068 # the calling Org. 6069 # 6070 # If Super-Admin, show all Grants for the Package. 6071 # orgId: Show all Grants to the specified Org. 6072 # 6073 # If the input organizationId is different from the calling Org, this will show 6074 # Grants for Packages 6075 # that are owned by the calling Org to the specified Org. 6076 # 6077 # If the input organizationId is the same as the caller's Org, this will show 6078 # Grants for Packages 6079 # to the calling Org. 6080 # 6081 # If Super-Admin, show Grants for all Packages to the specified Org. 6082 # includeDeleted: If true, result includes deleted packages 6083 # offset: Provide an offset to skip to a certain element in the 6084 # result, for paging. 6085 # limit: Specify maximum number of results to retrieve in this 6086 # result. Page size. 6087 ( 6088 ID, : 6089 ID, : 6090 Boolean, : 6091 Int, : 6092 Int, : 6093 PackageGrantFilter : 6094 ): PackageGrantList 6095 6096 # Retrieve the basic user information. 6097 # The caller and the queried user are required to be members of the same 6098 # organization, 6099 # unless the caller is superadmin user. 6100 # Example: 6101 # Request: 6102 # query { 6103 # 6104 # basicUserInfo(id: "267de7e1-efb2-444a-a524-210328b78503") { 6105 # 6106 # id 6107 # 6108 # name 6109 # 6110 # firstName 6111 # 6112 # lastName 6113 # 6114 # email 6115 # 6116 # imageUrl 6117 # 6118 # } 6119 # } 6120 # Response: 6121 # { 6122 # 6123 # "data": { 6124 # 6125 # "basicUserInfo": { 6126 # 6127 # "id": "267de7e1-efb2-444a-a524-210328b78503", 6128 # 6129 # "name": "username", 6130 # 6131 # "firstName": "first", 6132 # 6133 # "lastName": "last", 6134 # 6135 # "email": "email@test.com", 6136 # 6137 # "imageUrl": null 6138 # 6139 # } 6140 # 6141 # } 6142 # } 6143 # 6144 # Arguments 6145 # id: The user ID. 6146 # A user ID is a string in UUID format. 6147 ID!): BasicUserInfo ( : 6148 6149 ApiTokenInfo]! : [ 6150 6151 # Gets the most up to date package linked to this automate flow 6152 # 6153 # Arguments 6154 # engineId: Engine Id for the automate flow. 6155 ID!): Package ( : 6156 6157 # Retrieve applicationViewers 6158 # Example: 6159 # Request: 6160 # query { 6161 # applicationViewers(limit:2) { 6162 # records{ 6163 # id 6164 # name 6165 # } 6166 # } 6167 # } 6168 # Response: 6169 # { 6170 # "data": { 6171 # "viewers": { 6172 # "records": [ 6173 # { 6174 # "id": "2a1a1b58-6983-4002-b9ed-7b7f325f621a", 6175 # "name": "Viewer 1" 6176 # }, 6177 # { 6178 # "id": "4a2a1b58-6993-4002-b9ed-7b7f325f662c", 6179 # "name": "Viewer 2" 6180 # } 6181 # ] 6182 # } 6183 # } 6184 # } 6185 # 6186 # Arguments 6187 # ids: Provide an ids to retrieve specific viewers. 6188 # offset: Specify maximum number of results to retrieve in this 6189 # result. Page size. 6190 # limit: Specify maximum number of results to retrieve in this 6191 # result. 6192 # orderBy: Provide a list of ApplicationViewerSortField to sort 6193 # by. 6194 ( 6195 ID!], : [ 6196 Int, : 6197 Int, : 6198 ApplicationViewerSortField : 6199 ): ApplicationViewerList 6200 6201 # Query instance audit log configuration that includes: 6202 # - pool of events that are stored for audit purposes. Every instance is created 6203 # with a default subset of auditable events 6204 InstanceAuditLogConfig : 6205 6206 }
link Required by
This element is not required by anyone