How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Gencove project API

The project API from Gencove — 34 operation(s) for project.

Gencove project API is one of 20 APIs that Gencove publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Project. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 45 operations across 34 paths, and defines 61 schemas. It is described by OpenAPI 3.0.3, at version v2.

Requests are made against a single base URL, https://api.gencove.com.

45 operations 34 paths 61 schemas 4 DELETE20 GET1 PATCH20 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v2
Base URL
https://api.gencove.com/api/v2/
Authentication
API Key, API Key
License
Proprietary
Resource Areas
1

Authentication & Security 2

Gencove project API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (API key). An API key is passed in the header as Authorization (JWT).

  • API key — Authorization header content formated as: Api-Key You can obtain new API key through Gencove's web UI or user-api-key endpoint
  • JWT — Authorization header content formated as: Bearer You can obtain access token using jwt-create endpoint.

Paths & Operations 45

Across 34 paths, the API surfaces 45 operations — 4 DELETE, 20 GET, 1 PATCH, 20 POST. Each is listed below with its method, path, parameters, and response codes.

project 45
GET
/api/v2/project-batch-types/{project_id}
List batch types that are available for current project.
project_batch_types_list 3 params → 200
GET
/api/v2/project-batches/{project_id}
project_batches_list 3 params → 200
POST
/api/v2/project-batches/{project_id}
Handles batch creation for current project.
project_batches_create 1 param body → 201
POST
/api/v2/project-cancel-samples/{project_id}
View for canceling sample submission to analysis in a project.
project_cancel_samples_create 1 param body → 201
DELETE
/api/v2/project-delete-samples/{project_id}
project_delete_samples_destroy 1 param → 204
POST
/api/v2/project-hide-samples/{project_id}
project_hide_samples_create 1 param body → 204
GET
/api/v2/project-merge-vcfs/{project_id}
Return last known mergevcfs job.
project_merge_vcfs_retrieve 1 param → 200
POST
/api/v2/project-merge-vcfs/{project_id}
Post takes no parameters since mergevcfs job parameters are constructed by the backend.
project_merge_vcfs_create 1 param → 201
GET
/api/v2/project-organization-users/{project_id}
Get organization users.
project_organization_users_list 4 params → 200
GET
/api/v2/project-qc-report/{project_id}
Retrieve a CSV QC report for the supplied project ID
project_qc_report_retrieve 2 params → 200
GET
/api/v2/project-qc-types/{project_id}
List all available QC types for current project
project_qc_types_list 3 params → 200
GET
/api/v2/project-quality-control-histogram/{project_id}
Retrieve user project and desired qc results histogram.
project_quality_control_histogram_retrieve 11 params → 200
POST
/api/v2/project-restore-samples/{project_id}
Handles sample restore process for given sample ids in current project.
project_restore_samples_create 1 param body → 202
GET
/api/v2/project-roles/{role_id}
project_roles_retrieve 1 param → 200
DELETE
/api/v2/project-roles/{role_id}
project_roles_destroy 1 param → 204
GET
/api/v2/project-sample-manifests/{project_id}
project_sample_manifests_retrieve 1 param → 200
POST
/api/v2/project-sample-manifests/{project_id}
Upload sample manifest file for project
project_sample_manifests_create 2 params body → 201
POST
/api/v2/project-samples-copy/
Copy samples from another project into this one. Creates independent copies of the source samples in the destination project, producing new sample records. Only available when the organization has sa…
project_samples_copy_create body → 202
POST
/api/v2/project-samples-import/
Import samples from another project into this one. References the source samples in the destination project without duplicating the underlying data. Sample metadata can optionally be overridden as pa…
project_samples_import_create body → 202
GET
/api/v2/project-samples/{project_id}
List single project's associated samples.
project_samples_list 13 params → 200
POST
/api/v2/project-samples/{project_id}
Add samples to the project. Samples are added formatted as the results response value that was returned from /sample-sheet/ endpoint.
project_samples_create 1 param body → 201
POST
/api/v2/project-share-exit/
project_share_exit_create body → 200
POST
/api/v2/project-share-revoke/{project_share_id}
project_share_revoke_create 1 param body → 201
GET
/api/v2/project-shares/
project_shares_list 2 params → 200
POST
/api/v2/project-shares/
project_shares_create body → 201
GET
/api/v2/project-shares/{project_share_id}
project_shares_retrieve 1 param → 200
GET
/api/v2/project-stats/{project_id}
Retrieve user project and it's sample stats.
project_stats_retrieve 9 params → 200
GET
/api/v2/project-subscription-details/{subscription_id}
Details of a single subscription for project related events.
project_subscription_details_retrieve 1 param → 200
DELETE
/api/v2/project-subscription-details/{subscription_id}
Details of a single subscription for project related events.
project_subscription_details_destroy 1 param → 204
GET
/api/v2/project-subscription-event-types/
List subscription event types that are available for all projects.
project_subscription_event_types_list 2 params → 200
GET
/api/v2/project-subscription-notifications/{subscription_id}
List all available subscriptions for given project or create a new subscription.
project_subscription_notifications_list 3 params → 200
POST
/api/v2/project-subscription-secret/{subscription_id}
Set webhook secret for given subscription. Webhook secret is requested by the user and generated by Gencove.
project_subscription_secret_create 1 param → 200
POST
/api/v2/project-subscription-test/{subscription_id}
Send a dummy event for given subscription to test notifications integration. By default, there are no retries for this test endpoint.
project_subscription_test_create 1 param body → 202
GET
/api/v2/project-subscriptions/{project_id}
List all available subscriptions for given project or create a new subscription.
project_subscriptions_list 3 params → 200
POST
/api/v2/project-subscriptions/{project_id}
Add subscription to project events.
project_subscriptions_create 1 param body → 201
POST
/api/v2/project-unhide-samples/{project_id}
project_unhide_samples_create 1 param body → 204
GET
/api/v2/project-users/{project_id}
Get project users by project id.
project_users_list 5 params → 200
POST
/api/v2/project-users/{project_id}
project_users_create 1 param body → 201
GET
/api/v2/projects/
Retrieve list of user projects.
projects_list 10 params → 200
POST
/api/v2/projects/
Create project
projects_create body → 201
DELETE
/api/v2/projects-delete/
projects_delete_destroy → 204
POST
/api/v2/projects-hide/
projects_hide_create body → 204
POST
/api/v2/projects-unhide/
projects_unhide_create body → 204
GET
/api/v2/projects/{project_id}
Fetch single project details
projects_retrieve 1 param → 200
PATCH
/api/v2/projects/{project_id}
Update single project details
projects_partial_update 1 param body → 200

Schemas 61

The contract defines 61 schemas that model the data the API accepts and returns. The most detailed are ProjectDetail (17 properties), Project (16 properties), PatchedProject (16 properties), SampleList (11 properties). Each schema is shown below with its type and property counts.

ProjectHideUnhide
object
Serializer for hiding or unhiding a list of projects
1 property 1 required
BatchType
object
2 properties 1 required
ExistingSample
object
2 properties 1 required
BatchDetail
object
6 properties 5 required
ProjectSamplesImport
object
3 properties 2 required
FastqsNestedCreate
object
Serialized multiple uploads.models.Uploads objects with r1 and r2 names hardcoded.
2 properties 1 required
PaginatedBatchTypeList
object
2 properties 1 required
PaginatedOrganizationUserList
object
2 properties 1 required
ProjectShare
object
9 properties 9 required
PaginatedProjectList
object
2 properties 1 required
SampleRestore
object
Serializer for restoring samples from archived state. Initially samples are set as restorerequested and a celery task is kicked off that starts restore process…
3 properties 3 required
PaginatedProjectShareList
object
2 properties 1 required
ArchiveSampleStatus
object
4 properties 3 required
PaginatedSampleListList
object
2 properties 1 required
JobStatusNested
object
4 properties 2 required
SampleCounts
object
6 properties 6 required
SampleStatusNested
object
4 properties 2 required
PaginatedProjectSubscriptionNotificationList
object
2 properties 1 required
PaginatedQualityControlTypeList
object
2 properties 1 required
UploadNestedCreate
object
Used for adding samples using sample sheet to a project.
1 property 1 required
BatchCreate
object
3 properties 3 required
ProjectUsers
object
6 properties 4 required
SubscriptionTest
object
Used to accept requests to test subscriptions.
2 properties
BatchStatusNested
object
3 properties 2 required
EventTypeEnum
string
analysiscompletev2 - submitted project samples have completed analysis batchfinalreportcompletev2 - created subset of variants batch samplesrestored - samples…
PaginatedProjectSubscriptionList
object
2 properties 1 required
BatchList
object
5 properties 4 required
SampleList
object
11 properties 8 required
PaginatedBatchListList
object
2 properties 1 required
SampleManifestUpload
object
1 property 1 required
Project
object
16 properties 14 required
ProjectQualityControlHistogram
object
2 properties 2 required
ProjectSubscription
object
Subscription serializer where the scope is a project.
7 properties 6 required
PatchedProject
object
16 properties
ProjectDetail
object
Only used when retrieving a single Project.
17 properties 12 required
UserRoleObjectCreate
object
2 properties 2 required
ProjectShareStatusStatusEnum
string
shared - shared exited - exited revoked - revoked
ProtocolEnum
string
webhook - webhook email - email
ProjectStats
object
4 properties 4 required
ProjectShareExit
object
Serializer for exiting multiple project shares
1 property 1 required
ProjectMergeVCFsJob
object
5 properties 4 required
SampleSheetCreate
object
Adds samples with their uploads to the project. Samples are being created in create method of this serializer. They don't exist as objects in db before that.
3 properties 3 required
EventType
object
Serializing event types using EventType choices options.
2 properties 2 required
SampleHideUnhide
object
Serializer for hiding or unhidden a list of samples
1 property 1 required
QualityControlType
object
6 properties 6 required
ExtendedSampleSheetCreate
object
Adds samples with their uploads to the project and attaches same metadata to all of them.
2 properties 1 required
ProjectSubscriptionNotification
object
4 properties 2 required
OrganizationUser
object
7 properties 5 required
PaginatedProjectUsersList
object
2 properties 1 required
SubscriptionSecret
object
Serialize secret of a subscription. Used only for returning the secret, not reading it because the secret is safely encypted in the db.
1 property 1 required
SubscriptionCreate
object
Generic Subscription serializer without scope object.
4 properties 3 required
ProjectShareStatus
object
4 properties 1 required
NullEnum
EventTypesEnum
string
analysiscompletev2 - submitted project samples have completed analysis batchfinalreportcompletev2 - created subset of variants batch samplesrestored - samples…
ShareLevelEnum
string
viewer - viewer analyst - analyst
BatchFileNested
object
Sets batch.id as filename in file downloadurl.
7 properties 3 required
UserRoleObject
object
2 properties 2 required
ProjectFileNested
object
Used for all nested files except for files associated with sample.
7 properties 3 required
ProjectCancelSamples
object
Serializer for canceling samples submitted to a project.
1 property 1 required
PaginatedEventTypeList
object
2 properties 1 required
ProjectShareRevoke
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gencove-project-api-openapi.yml Raw ↑

Other APIs Gencove publishes across the network.

Gencove array API
Gencove basespace API
Gencove batch API
Gencove billing API
Gencove explorer API
Gencove file API
Gencove firstmile API
Gencove invitation API
Gencove jwt API
Gencove mfa API
Gencove notification API
Gencove organization API
Where this information came from

This is an independent, third-party profile of Gencove project API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.